Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MRG: update docs for tax grep: only searches tax #2789

Merged
merged 1 commit into from
Sep 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -1041,6 +1041,9 @@ superkingdom, phylum, class, order, family, genus, and species.
to ignore case and `-v` to output only taxonomic lineages that do
_not_ match the pattern.

Note: `tax grep` only searches taxonomic ranks, not identifier strings.
Use `sig grep` to search for identifiers in sketch collections.

Currently only CSV output (optionally gzipped) is supported; use `sourmash tax prepare` to
convert CSV output from `tax grep` into a sqlite3 taxonomy database.

Expand Down
5 changes: 4 additions & 1 deletion src/sourmash/cli/tax/grep.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""search taxonomies and output picklists.."""
"""search taxonomies and output picklists."""

usage="""
Expand All @@ -9,6 +9,9 @@
It creates new files containing matching taxonomic entries; these new
files can serve as taxonomies and can also be used as picklists.
`tax grep` only searches taxonomic ranks, not identifier strings.
Use `sig grep` to search for identifiers in sketch collections.
Please see the 'tax grep' documentation for more details:
https://sourmash.readthedocs.io/en/latest/command-line.html#sourmash-tax-grep-subset-taxonomies-and-create-picklists-based-on-taxonomy-string-matches
"""
Expand Down
Loading