diff --git a/doc/command-line.md b/doc/command-line.md index 70b39cf7d2..ebc5fae01b 100644 --- a/doc/command-line.md +++ b/doc/command-line.md @@ -192,13 +192,13 @@ The `compare` subcommand compares one or more signatures (if signatures are created with `-p abund`) the [angular similarity](https://en.wikipedia.org/wiki/Cosine_similarity#Angular_distance_and_similarity). -The default output -is a text display of a similarity matrix where each entry `[i, j]` -contains the estimated Jaccard index between input signature `i` and -input signature `j`. The output matrix can be saved to a file -with `--output` and used with the `sourmash plot` subcommand (or loaded -with `numpy.load(...)`. Using `--csv` will output a CSV file that can -be loaded into other languages than Python, such as R. +The default output is a text display of a similarity matrix where each +entry `[i, j]` contains the estimated Jaccard index between input +signature `i` and input signature `j`. The output matrix can be saved +to a numpy binary file with `--output ` and used with the +`sourmash plot` subcommand (or loaded with `numpy.load(...)`. Using +`--csv ` will output a CSV file that can be loaded into +other languages than Python, such as R. As of sourmash 4.4.0, `compare` also supports Average Nucleotide Identity (ANI) estimates instead of Jaccard or containment index; use @@ -206,20 +206,20 @@ Identity (ANI) estimates instead of Jaccard or containment index; use Usage: ``` -sourmash compare [ ... ] +sourmash compare [ ... ] ``` Options: -* `--output` -- save the output matrix to this file (as a numpy binary matrix). +* `--output ` -- save the output matrix to this file (as a numpy binary matrix). * `--distance-matrix` -- create and output a distance matrix, instead of a similarity matrix. -* `--ksize` -- do the comparisons at this k-mer size. +* `--ksize ` -- do the comparisons at this k-mer size. * `--containment` -- calculate containment instead of similarity; `C(i, j) = size(i intersection j) / size(i)` * `--ani` -- output estimates of Average Nucleotide Identity (ANI) instead of Jaccard similarity or containment. -* `--from-file` -- append the list of files in this text file to the input - signatures. +* `--from-file ` -- append the list of files in this text file to the input signatures. * `--ignore-abundance` -- ignore abundances in signatures. -* `--picklist` -- select a subset of signatures with [a picklist](#using-picklists-to-subset-large-collections-of-signatures) +* `--picklist ::` -- select a subset of signatures with [a picklist](#using-picklists-to-subset-large-collections-of-signatures) +* `--csv ` -- save the output matrix in CSV format. **Note:** compare by default produces a symmetric similarity matrix that can be used for clustering in downstream tasks. With `--containment`, diff --git a/src/sourmash/cli/compare.py b/src/sourmash/cli/compare.py index 77671d01a2..7659c0697c 100644 --- a/src/sourmash/cli/compare.py +++ b/src/sourmash/cli/compare.py @@ -9,9 +9,10 @@ The default output is a text display of a similarity matrix where each entry `[i, j]` contains the estimated Jaccard index between input signature `i` and input signature `j`. The output matrix can be saved -to a file with `--output` and used with the `sourmash plot` subcommand -(or loaded with `numpy.load(...)`. Using `--csv` will output a CSV -file that can be loaded into other languages than Python, such as R. +to a file with `--output ` and used with the `sourmash +plot` subcommand (or loaded with `numpy.load(...)`. Using `--csv +` will output a CSV file that can be loaded into other +languages than Python, such as R. Command line usage: ```