From fcc4d99b7be61e9760bf7fefbe2be561d71b6391 Mon Sep 17 00:00:00 2001 From: "C. Titus Brown" Date: Thu, 28 Sep 2023 10:26:04 -0700 Subject: [PATCH] update docs --- doc/command-line.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/command-line.md b/doc/command-line.md index eda5b2ac2c..492012c42a 100644 --- a/doc/command-line.md +++ b/doc/command-line.md @@ -259,15 +259,18 @@ sourmash plot ``` Options: -``` ---pdf -- output PDF files. ---labels -- display the signature names (by default, the filenames) on the plot ---indices -- turn off index display on the plot. ---vmax -- maximum value (default 1.0) for heatmap. ---vmin -- minimum value (default 0.0) for heatmap. ---subsample= -- plot a maximum of samples, randomly chosen. ---subsample-seed= -- seed for pseudorandom number generator. -``` +* `--pdf` -- output PDF files. (defaults to PNG) +* `--labels` -- display the signature names on the plot (default) +* `--indices` -- turn on index display on the plot. +* `--vmax` -- maximum value (default 1.0) for heatmap. +* `--vmin` -- minimum value (default 0.0) for heatmap. +* `--subsample=` -- plot a maximum of samples, randomly chosen. +* `--subsample-seed=` -- seed for pseudorandom number generator. + +Example command lines for labels and indices - + +* `--indices` will show only numbers; +* `--no-labels --no-indices` will remove all labels! Example output: