Fork me on GitHub

summarize: Summarize tableΒΆ

Docstring:

Usage: qiime feature-table summarize [OPTIONS]

  Generate visual and tabular summaries of a feature table.

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency | PresenceAbsence]
                         The feature table to be summarized.        [required]
Parameters:
  --m-sample-metadata-file METADATA...
    (multiple            The sample metadata.
     arguments will be
     merged)                                                        [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: feature table summarize
  qiime feature-table summarize \
    --i-table feature-table.qza \
    --o-visualization table.qzv

Import:

from qiime2.plugins.feature_table.visualizers import summarize

Docstring:

Summarize table

Generate visual and tabular summaries of a feature table.

Parameters
----------
table : FeatureTable[Frequency | PresenceAbsence]
    The feature table to be summarized.
sample_metadata : Metadata, optional
    The sample metadata.

Returns
-------
visualization : Visualization