Skip to content

Commit

Permalink
added description
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard A. Schäfer authored and Richard A. Schäfer committed Jan 20, 2021
1 parent 404b25a commit 4e5ab59
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,18 @@ and cmake into the root directory.
```
cmake ../source/
```
This should be sufficient if the dependencies are located in $PATH. Calling `make` builds RNAnue.
This is be sufficient if the dependencies are located in $PATH. Calling `make` builds RNAnue.

## Overview

![Principle](principle.png)

## Usage
In principle, the parameters of RNAnue can be specified on the command line. However

### Positional Arguments
RNAnue provides different functional arguments for individual procedures. These include `RNAnue preproc`,
`RNAnue align`, `RNAnue clustering`, `RNAnue analysis`.
`RNAnue align`, `RNAnue clustering`, `RNAnue analysis`. In additon, `RNAnue complete` applies the whole
workflow.

## Parameters
RNAnue accepts parameter settings both from the commandline and through a configuration file.
Expand All @@ -38,18 +43,19 @@ RNAnue subcall --config /path/to/params.cfg
```
In any case, the specifying parameters over the command lines has precedence over the config file.

### Docker
In additon, we provide a ready-to-use Docker container that has RNAnue preconfigured.
https://hub.docker.com/repository/docker/cobirna/rnanue

### Preproc
## Results

### Align
In principle, the results of the analysis are stored in the specified output folder and its subfolders
(e.g., ./preproc, ./align, ./clustering, ./analysis). RNAnue reports the split reads in SAM format, the clusters
and the RNA-RNA interactions. RNAnue reports the split reads in SAM format. Additionally, the complementarity
scores and hybridization energies are stored in the tags FC and FE, respectively. We report the clusters in a
custom format that includes the IDs of the clusters, its length, size and genomic coordinates.

### Clustering

### Analysis
### Docker
In additon, we provide a ready-to-use Docker container that has RNAnue preconfigured.
https://hub.docker.com/repository/docker/cobirna/rnanue

## Output

# Troubleshooting
contact [email protected] or create an issue
Binary file added principle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4e5ab59

Please sign in to comment.