partial-procrustes: Partial Procrustes¶

Docstring:

Usage: qiime diversity partial-procrustes [OPTIONS]

  Transform one ordination into another, using paired samples to anchor the
  transformation. This method allows does not require all samples to be
  paired.

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:
  --m-pairing-file METADATA
  --m-pairing-column COLUMN  MetadataColumn[Categorical]
                          The metadata column describing sample pairs which
                          exist.                                    [required]
  --p-dimensions INTEGER  The number of dimensions to use when fitting the
    Range(1, None)        two matrices                            [default: 5]
Outputs:
  --o-transformed ARTIFACT
    PCoAResults           The 'other' ordination transformed into the space
                          of the reference ordination.              [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.