Skip to content

Commit

Permalink
update image and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cokelaer committed Jan 23, 2022
1 parent fd77da4 commit de439e5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,12 @@ This is is the **ribofinder** pipeline from the `Sequana <https://sequana.readth
Installation
~~~~~~~~~~~~

You must install Sequana first (use --upgrade to get the latest version installed)::

pip install sequana --upgrade

Then, just install this package::
Using **pip** from Python, just install this package::

pip install sequana_ribofinder --upgrade

The **--upgrade** option is to make sure you'll get the latest version.

Usage
~~~~~

Expand All @@ -42,7 +40,7 @@ For help, please type::

The following command searches for input files in DATAPATH. Then, te user provide
a list of rRNA sequences in FastA format in *test.fasta*. This command creates a directory
called ribofinder/ where a snakemake pipeline can
called ribofinder/ where a snakemake pipeline can::

sequana_ribofinder --input-directory DATAPATH --rRNA-file test.fasta

Expand Down Expand Up @@ -76,17 +74,18 @@ Details
This pipeline runs **ribofinder** in parallel on the input fastq files.
A brief sequana summary report is also produced.

You can start from the reference file and the GFF file. By defaultm we search for the feature called
rRNA::
You can start from the reference file and the GFF file. By default we search for the feature called
rRNA to be found in the GFF file::

sequana_ribofinder --input-directory . --reference-file genome.fasta --gff-file genome.gff

If the default feature rRNA is not found, no error is raised for now. If you know the expected feature,
you can provide it::
you can provide it though::

sequana_ribofinder --input-directory . --reference-file genome.fasta --gff-file genome.gff --rRNA-feature gene_rRNA

If you have an existing or custom rRNA file, you can then use::
If you have an existing or custom rRNA file, you can then use it as follows, in which case, no input reference is
required::

sequana_ribofinder --input-directory . --rRNA-file ribo.fasta

Expand Down
Binary file modified sequana_pipelines/ribofinder/dag.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 de439e5

Please sign in to comment.