Fork me on GitHub

summarize: Summarize tableΒΆ

Docstring:

Usage: qiime feature-table summarize [OPTIONS]

  Generate visual and tabular summaries of a feature table.

Options:
  --i-table ARTIFACT PATH FeatureTable[Frequency | PresenceAbsence | RelativeFrequency]
                                  The feature table to be summarized.
                                  [required]
  --m-sample-metadata-file MULTIPLE FILE
                                  Metadata file or artifact viewable as
                                  metadata. This option may be supplied
                                  multiple times to merge metadata. The sample
                                  metadata.  [optional]
  --o-visualization VISUALIZATION PATH
                                  [required if not passing --output-dir]
  --output-dir DIRECTORY          Output unspecified results to a directory
  --cmd-config FILE               Use config file for command options
  --verbose                       Display verbose output to stdout and/or
                                  stderr during execution of this action.
                                  [default: False]
  --quiet                         Silence output if execution is successful
                                  (silence is golden).  [default: False]
  --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 | PresenceAbsence | RelativeFrequency]
    The feature table to be summarized.
sample_metadata : Metadata, optional
    The sample metadata.

Returns
-------
visualization : Visualization