Fork me on GitHub

plot-rainclouds: Raincloud plotsΒΆ

Docstring:

Usage: qiime stats plot-rainclouds [OPTIONS]

  Plot raincloud distributions for each group.

Inputs:
  --i-data ARTIFACT Dist1D[Multi | Ordered | Unordered | NestedOrdered |
    NestedUnordered, Matched | Independent]
                         The group distributions to plot.           [required]
  --i-stats ARTIFACT StatsTable[Pairwise]
                         Statistical tests to display.              [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: plot rainclouds
  qiime stats plot-rainclouds \
    --i-data dist.qza \
    --o-visualization raincloud-plot.qzv

Import:

from qiime2.plugins.stats.visualizers import plot_rainclouds

Docstring:

Raincloud plots

Plot raincloud distributions for each group.

Parameters
----------
data : Dist1D[Multi | Ordered | Unordered | NestedOrdered | NestedUnordered, Matched | Independent]
    The group distributions to plot.
stats : StatsTable[Pairwise], optional
    Statistical tests to display.

Returns
-------
visualization : Visualization