Fork me on GitHub

procrustes-analysis: Procrustes AnalysisΒΆ

Docstring:

Usage: qiime diversity procrustes-analysis [OPTIONS]

  Fit two ordination matrices with Procrustes analysis

Inputs:
  --i-reference ARTIFACT  The ordination matrix to which data is fitted to.
    PCoAResults                                                     [required]
  --i-other ARTIFACT      The ordination matrix that's fitted to the
    PCoAResults           reference ordination.                     [required]
Parameters:
  --p-dimensions INTEGER
    Range(1, None)                                                [default: 5]
Outputs:
  --o-transformed-reference ARTIFACT
    PCoAResults           A normalized version of the "reference" ordination
                          matrix.                                   [required]
  --o-transformed-other ARTIFACT
    PCoAResults           A normalized and fitted version of the "other"
                          ordination matrix.                        [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).
  --citations             Show citations and exit.
  --help                  Show this message and exit.

Import:

from qiime2.plugins.diversity.methods import procrustes_analysis

Docstring:

Procrustes Analysis

Fit two ordination matrices with Procrustes analysis

Parameters
----------
reference : PCoAResults
    The ordination matrix to which data is fitted to.
other : PCoAResults
    The ordination matrix that's fitted to the reference ordination.
dimensions : Int % Range(1, None), optional

Returns
-------
transformed_reference : PCoAResults
    A normalized version of the "reference" ordination matrix.
transformed_other : PCoAResults
    A normalized and fitted version of the "other" ordination matrix.