Fork me on GitHub

barplot: Visualize taxonomy with an interactive bar plotΒΆ

Docstring:

Usage: qiime taxa barplot [OPTIONS]

  This visualizer produces an interactive barplot visualization of
  taxonomies. Interactive features include multi-level sorting, plot
  recoloring, sample relabeling, and SVG figure export.

Options:
  --i-table ARTIFACT PATH FeatureTable[Frequency]
                                  Feature table to visualize at various
                                  taxonomic levels.  [required]
  --i-taxonomy ARTIFACT PATH FeatureData[Taxonomy]
                                  Taxonomic annotations for features in the
                                  provided feature table. All features in the
                                  feature table must have a corresponding
                                  taxonomic annotation. Taxonomic annotations
                                  that are not present in the feature table
                                  will be ignored.  [required]
  --m-metadata-file MULTIPLE FILE
                                  Metadata file or artifact viewable as
                                  metadata. This option may be supplied
                                  multiple times to merge metadata. The sample
                                  metadata.  [required]
  --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.taxa.visualizers import barplot

Docstring:

Visualize taxonomy with an interactive bar plot

This visualizer produces an interactive barplot visualization of
taxonomies. Interactive features include multi-level sorting, plot
recoloring, sample relabeling, and SVG figure export.

Parameters
----------
table : FeatureTable[Frequency]
    Feature table to visualize at various taxonomic levels.
taxonomy : FeatureData[Taxonomy]
    Taxonomic annotations for features in the provided feature table. All
    features in the feature table must have a corresponding taxonomic
    annotation. Taxonomic annotations that are not present in the feature
    table will be ignored.
metadata : Metadata
    The sample metadata.

Returns
-------
visualization : Visualization