Warning
This site has been replaced by the new QIIME 2 “amplicon distribution” documentation, as of the 2025.4 release of QIIME 2. You can still access the content from the “old docs” here for the QIIME 2 2024.10 and earlier releases, but we recommend that you transition to the new documentation at https://amplicon-docs.qiime2.org. Content on this site is no longer updated and may be out of date.
Are you looking for:
the QIIME 2 homepage? That’s https://qiime2.org.
learning resources for microbiome marker gene (i.e., amplicon) analysis? See the QIIME 2 amplicon distribution documentation.
learning resources for microbiome metagenome analysis? See the MOSHPIT documentation.
installation instructions, plugins, books, videos, workshops, or resources? See the QIIME 2 Library.
general help? See the QIIME 2 Forum.
Old content beyond this point… 👴👵
boxplot: Boxplot¶
Docstring:
Usage: qiime vizard boxplot [OPTIONS] Basic boxplot for visualizing a numeric Metadata measure grouped by a categorical Metadata measure with choices for the whisker range. Parameters: --m-metadata-file METADATA... (multiple arguments Any metadata-like input with at least one numeric will be merged) measure and one categorical measure for visualizing. [required] --p-distribution-measure TEXT The numeric measure that will be used to create each box plot distribution. [required] --p-group-by TEXT The categorical measure that will be used to group the data into separate box plots. If left blank, all data will be represented within a single box. [optional] --p-whisker-range TEXT Choices('tukeys_iqr', 'percentile', 'minmax') The range that will be used for calculating the whisker lengths for each box. Options are `tukeys_iqr` (1.5 IQR clamped to the data extent), `percentile` (91th/9th percentile), or `minmax`. Any data points that fall outside of the chosen range will be represented as outliers that are plotted as circular points, unless the `suppressOutliers` checkbox has been enabled on the rendered visualization. [default: 'percentile'] --p-box-orientation TEXT Choices('horizontal', 'vertical') The visual orientataion of the boxes (either horizontal or vertical). [default: 'horizontal'] --p-title TEXT The title of the boxplot. [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.
Import:
from qiime2.plugins.vizard.visualizers import boxplot
Docstring:
Boxplot Basic boxplot for visualizing a numeric Metadata measure grouped by a categorical Metadata measure with choices for the whisker range. Parameters ---------- metadata : Metadata Any metadata-like input with at least one numeric measure and one categorical measure for visualizing. distribution_measure : Str The numeric measure that will be used to create each box plot distribution. group_by : Str, optional The categorical measure that will be used to group the data into separate box plots. If left blank, all data will be represented within a single box. whisker_range : Str % Choices('tukeys_iqr', 'percentile', 'minmax'), optional The range that will be used for calculating the whisker lengths for each box. Options are `tukeys_iqr` (1.5 IQR clamped to the data extent), `percentile` (91th/9th percentile), or `minmax`. Any data points that fall outside of the chosen range will be represented as outliers that are plotted as circular points, unless the `suppressOutliers` checkbox has been enabled on the rendered visualization. box_orientation : Str % Choices('horizontal', 'vertical'), optional The visual orientataion of the boxes (either horizontal or vertical). title : Str, optional The title of the boxplot. Returns ------- visualization : Visualization