Skip to content

Commit

Permalink
MRG: update docs for tax grep: only searches tax (#2789)
Browse files Browse the repository at this point in the history
Updates `tax grep` documentation to make it clear that it only searches
taxonomic
ranks, not identifiers; `sig grep` searches sketch names.

Fixes #2607
  • Loading branch information
ctb authored Sep 28, 2023
1 parent f19af8c commit ba1fd3e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
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

0 comments on commit ba1fd3e

Please sign in to comment.