lineplot: Lineplot¶

Docstring:

Usage: qiime vizard lineplot [OPTIONS]

  Basic lineplot for visualizing two numeric Metadata measures with optional
  grouping. All numeric columns present in the Metadata will be available as
  drop-down options on the Y-axis, but the chosen `x_measure` remains fixed.

Parameters:
  --m-metadata-file METADATA...
    (multiple            Any metadata-like input with at least two numeric
     arguments will be   measures for visualizing.
     merged)                                                        [required]
  --p-x-measure TEXT     Numeric measure from the input Metadata that should
                         be plotted on the x-axis.                  [required]
  --p-y-measure TEXT     Numeric measure from the input Metadata that should
                         be plotted on the y-axis.                  [required]
  --p-replicate-method TEXT Choices('none', 'median', 'mean')
                         The method for averaging replicates if present in
                         the chosen `x-measure`. Available methods are
                         `median` and `mean`.                [default: 'none']
  --p-group-by TEXT      Categorical measure from the input Metadata that
                         should be used for grouping the lineplot.  [optional]
  --p-title TEXT         The title of the lineplot.                 [optional]
Outputs:
  --o-visualization VISUALIZATION
                                                                    [required]
Miscellaneous:
  --output-dir PATH      Output unspecified results to a directory
  --verbose / --quiet    Display verbose output to stdout and/or stderr
                         during execution of this action. Or silence output if
                         execution is successful (silence is golden).
  --example-data PATH    Write example data and exit.
  --citations            Show citations and exit.
  --use-cache DIRECTORY  Specify the cache to be used for the intermediate
                         work of this action. If not provided, the default
                         cache under $TMP/qiime2/ will be used.
                         IMPORTANT FOR HPC USERS: If you are on an HPC system
                         and are using parallel execution it is important to
                         set this to a location that is globally accessible to
                         all nodes in the cluster.
  --help                 Show this message and exit.

Examples:
  # ### example: lineplot median replicates with grouping
  qiime vizard lineplot \
    --m-metadata-file metadata.tsv \
    --p-x-measure x \
    --p-y-measure y \
    --p-group-by group \
    --p-replicate-method median \
    --p-title 'Lineplot with median replicate method, grouped by `group`.' \
    --o-visualization lineplot.qzv

  # ### example: lineplot mean replicates with grouping
  qiime vizard lineplot \
    --m-metadata-file metadata.tsv \
    --p-x-measure x \
    --p-y-measure y \
    --p-group-by group \
    --p-replicate-method mean \
    --p-title 'Lineplot with mean replicate method, grouped by `group`.' \
    --o-visualization lineplot.qzv

  # ### example: lineplot median replicates no grouping
  qiime vizard lineplot \
    --m-metadata-file metadata.tsv \
    --p-x-measure x \
    --p-y-measure y \
    --p-replicate-method median \
    --p-title 'Lineplot with median replicate method (no grouping).' \
    --o-visualization lineplot.qzv

  # ### example: lineplot mean replicates no grouping
  qiime vizard lineplot \
    --m-metadata-file metadata.tsv \
    --p-x-measure x \
    --p-y-measure y \
    --p-replicate-method mean \
    --p-title 'Lineplot with mean replicate method (no grouping).' \
    --o-visualization lineplot.qzv

  # ### example: lineplot no replicates with grouping
  qiime vizard lineplot \
    --m-metadata-file metadata.tsv \
    --p-x-measure a \
    --p-y-measure y \
    --p-group-by group \
    --p-title 'Lineplot with no replicate method, grouped by `group`.' \
    --o-visualization lineplot.qzv

  # ### example: lineplot no replicates no grouping
  qiime vizard lineplot \
    --m-metadata-file metadata.tsv \
    --p-x-measure b \
    --p-y-measure y \
    --p-title 'Lineplot with no replicate method (no grouping).' \
    --o-visualization lineplot.qzv