Skip to content

Commit 45e7f88

Browse files
authored
Update usage.rst
Corrected typo hiding the command to run the whole pipeline. Added additional notes about assembly, mapping, classify and annotate rules.
1 parent 10c9a04 commit 45e7f88

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/usage.rst

+5
Original file line numberDiff line numberDiff line change
@@ -284,12 +284,17 @@ Running
284284
To run Sunbeam, make sure you've activated the sunbeam environment. Then run:
285285

286286
.. code-block:: shell
287+
287288
sunbeam run --profile path/to/project/
288289
289290
There are many options that you can use to determine which outputs you want. By default, if nothing is specified, this runs the entire pipeline. However, each section is broken up into subsections that can be called individually, and will only execute the steps necessary to get their outputs. These are specified after the command above and consist of the following:
290291

291292
* ``all_qc``: basic quality control on all reads
292293
* ``all_decontam``: quality control and host read removal on all samples
294+
* ``all_assembly``: assemble contigs on all samples
295+
* ``all_mapping``: map all samples to target genomes
296+
* ``all_classify``: taxonomic classification on all samples
297+
* ``all_annontate``: annotate contigs on all samples
293298

294299
To use one of these options, simply run it like so:
295300

0 commit comments

Comments
 (0)