Fork me on GitHub

distance-matrix: Create a distance matrix from a numeric Metadata columnΒΆ

Docstring:

Usage: qiime metadata distance-matrix [OPTIONS]

  Create a distance matrix from a numeric metadata column. The Euclidean
  distance is computed between each pair of samples or features in the
  column.

  Tip: the distance matrix produced by this method can be used as input to
  the Mantel test available in `q2-diversity`.

Options:
  --m-metadata-file MULTIPLE FILE
                                  Metadata file or artifact viewable as
                                  metadata. This option may be supplied
                                  multiple times to merge metadata.
                                  [required]
  --m-metadata-column MetadataColumn[Numeric]
                                  Column from metadata file or artifact
                                  viewable as metadata. Numeric metadata
                                  column to compute pairwise Euclidean
                                  distances from  [required]
  --o-distance-matrix ARTIFACT PATH DistanceMatrix
                                  [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.metadata.methods import distance_matrix

Docstring:

Create a distance matrix from a numeric Metadata column

Create a distance matrix from a numeric metadata column. The Euclidean
distance is computed between each pair of samples or features in the
column.  Tip: the distance matrix produced by this method can be used as
input to the Mantel test available in `q2-diversity`.

Parameters
----------
metadata : MetadataColumn[Numeric]
    Numeric metadata column to compute pairwise Euclidean distances from

Returns
-------
distance_matrix : DistanceMatrix