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 | RelativeFrequency |
    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).
  --citations          Show citations and exit.
  --help               Show this message and exit.

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 | RelativeFrequency | PresenceAbsence]
    The feature table to be summarized.
sample_metadata : Metadata, optional
    The sample metadata.

Returns
-------
visualization : Visualization