Skip to content

Commit 584f9ea

Browse files
authored
Update Readme.md
1 parent cd69112 commit 584f9ea

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

Readme.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,26 @@ about them being invalid.
9191
### Running sunbeam
9292

9393
```sh
94-
snakemake --configfile=<my-config.yml>
94+
snakemake --configfile=<my-config.yml> [optional rule]
9595
```
9696

97-
will print out a list of samples that it found according to your specified
98-
config file and invites you to peruse the list of rules by executing
99-
`snakemake --configfile=<my-config.yml> --list`.
97+
Running sunbeam without specifying a rule will perform, by default:
98+
99+
- quality control
100+
- host read filtering
101+
- read-level classification from given Kraken database
102+
- contig assembly
103+
- gene detection
104+
- blasting of genes and contigs against given databases
105+
106+
Each step of this can be run piecemeal by using the rules starting with "all", such as:
107+
108+
- all_qc: quality control on all reads
109+
- all_decontam: remove all host reads
110+
- all_classify: classify all reads
111+
- all_assembly: build contigs
112+
- all_annotate: annotate all contigs
113+
114+
Example: decontaminate all host reads with ```snakemake --configfile=my_config.yml all_decontam```
115+
116+
You can also see what samples Sunbeam detected by running ```snakemake --configfile=my_config.yml samples```.

0 commit comments

Comments
 (0)