Fork me on GitHub

scatterplot-2d: 2D ScatterplotΒΆ

Docstring:

Usage: qiime vizard scatterplot-2d [OPTIONS]

  Basic 2D scatterplot for visualizing two numeric Metadata measures with
  optional categorical color grouping.

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.                  [optional]
  --p-y-measure TEXT     Numeric measure from the input Metadata that should
                         be plotted on the y-axis.                  [optional]
  --p-color-by TEXT      Categorical measure from the input Metadata that
                         should be used for color-coding the scatterplot.
                                                                    [optional]
  --p-title TEXT         The title of the scatterplot.              [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: scatterplot defaults
  qiime vizard scatterplot-2d \
    --m-metadata-file metadata.tsv \
    --o-visualization scatterplot.qzv

  # ### example: scatterplot all measures
  qiime vizard scatterplot-2d \
    --m-metadata-file metadata.tsv \
    --p-x-measure x \
    --p-y-measure y \
    --p-color-by group \
    --o-visualization scatterplot.qzv

Import:

from qiime2.plugins.vizard.visualizers import scatterplot_2d

Docstring:

2D Scatterplot

Basic 2D scatterplot for visualizing two numeric Metadata measures with
optional categorical color grouping.

Parameters
----------
metadata : Metadata
    Any metadata-like input with at least two numeric measures for
    visualizing.
x_measure : Str, optional
    Numeric measure from the input Metadata that should be plotted on the
    x-axis.
y_measure : Str, optional
    Numeric measure from the input Metadata that should be plotted on the
    y-axis.
color_by : Str, optional
    Categorical measure from the input Metadata that should be used for
    color-coding the scatterplot.
title : Str, optional
    The title of the scatterplot.

Returns
-------
visualization : Visualization