Skip to content

Commit 65fae17

Browse files
committed
docs(readme): update CLI help usage with new single-dash aliases
1 parent 733fc9e commit 65fae17

1 file changed

Lines changed: 21 additions & 19 deletions

File tree

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -69,24 +69,26 @@ Usage: KrakenParser [OPTIONS] COMMAND [ARGS]...
6969
to see options for a specific step.
7070
7171
╭─ Options ────────────────────────────────────────────────────────────────────╮
72-
│ --input -i PATH Directory containing Kraken2 report files. │
73-
│ --output -o PATH Output directory. │
74-
│ --viruses Extract only VIRUSES domain taxa in the │
75-
│ pipeline. │
76-
│ --bacteria Extract only BACTERIA domain taxa in the │
77-
│ pipeline. │
78-
│ --fungi Extract only FUNGI kingdom taxa in the │
79-
│ pipeline. │
80-
│ --archaea Extract only ARCHAEA domain taxa in the │
81-
│ pipeline. │
82-
│ --keep-human Do not filter human-related taxa. │
83-
│ --version -V Show version and exit. │
84-
│ --depth -d INTEGER Rarefaction depth for β-diversity. │
85-
│ [default: 1000] │
86-
│ --seed -s INTEGER Random seed for reproducible rarefaction. │
87-
│ --overwrite Overwrite the output directory if it already │
88-
│ exists. │
89-
│ --help -h Show this message and exit. │
72+
│ --input -i PATH Directory containing Kraken2 report │
73+
│ files. │
74+
│ --output -o PATH Output directory. │
75+
│ --viruses -viruses Extract only VIRUSES domain taxa in │
76+
│ the pipeline. │
77+
│ --bacteria -bacteria Extract only BACTERIA domain taxa in │
78+
│ the pipeline. │
79+
│ --fungi -fungi Extract only FUNGI kingdom taxa in │
80+
│ the pipeline. │
81+
│ --archaea -archaea Extract only ARCHAEA domain taxa in │
82+
│ the pipeline. │
83+
│ --keep-human -keep-human Do not filter human-related taxa. │
84+
│ --version -V Show version and exit. │
85+
│ --depth -d INTEGER Rarefaction depth for β-diversity. │
86+
│ [default: 1000] │
87+
│ --seed -s INTEGER Random seed for reproducible │
88+
│ rarefaction. │
89+
│ --overwrite -overwrite Overwrite the output directory if it │
90+
│ already exists. │
91+
│ --help -h Show this message and exit. │
9092
╰──────────────────────────────────────────────────────────────────────────────╯
9193
╭─ Advanced (Step-by-step pipeline control) ───────────────────────────────────╮
9294
│ mpa Convert a Kraken2 report to MetaPhlAn (MPA) format. │
@@ -319,7 +321,7 @@ results/
319321
│ ├─ counts_genus.txt
320322
│ ├─ ...
321323
│ └─ counts_phylum.txt
322-
└─ krakenparser.log # Pipeline execution logs
324+
└─ krakenparser.log # Pipeline execution logs
323325
```
324326

325327
## Conclusion

0 commit comments

Comments
 (0)