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… 👴👵
heatmap: Heatmap¶
Docstring:
Usage: qiime vizard heatmap [OPTIONS] Basic heatmap for visualizing three Metadata measures. Parameters: --m-metadata-file METADATA... (multiple Any metadata-like input that contains at least three arguments will be measures for visualizing, one of which must be merged) numeric. [required] --p-x-measure TEXT Numeric or categorical measure from the input Metadata that should be plotted on the x-axis. [required] --p-y-measure TEXT Numeric or categorical measure from the input Metadata that should be plotted on the y-axis. [required] --p-gradient-measure TEXT Numeric measure from the input Metadata that should be used to represent the color gradient in the heatmap. [required] --p-title TEXT The title of the heatmap. [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: heatmap qiime vizard heatmap \ --m-metadata-file metadata.tsv \ --p-x-measure x \ --p-y-measure y \ --p-gradient-measure a \ --o-visualization heatmap.qzv
Import:
from qiime2.plugins.vizard.visualizers import heatmap
Docstring:
Heatmap Basic heatmap for visualizing three Metadata measures. Parameters ---------- metadata : Metadata Any metadata-like input that contains at least three measures for visualizing, one of which must be numeric. x_measure : Str Numeric or categorical measure from the input Metadata that should be plotted on the x-axis. y_measure : Str Numeric or categorical measure from the input Metadata that should be plotted on the y-axis. gradient_measure : Str Numeric measure from the input Metadata that should be used to represent the color gradient in the heatmap. title : Str, optional The title of the heatmap. Returns ------- visualization : Visualization