Fork me on GitHub

beta-passthrough: Beta Passthrough (non-phylogenetic)ΒΆ

Docstring:

Usage: qiime diversity-lib beta-passthrough [OPTIONS]

  Computes a distance matrix for all pairs of samples in a feature table
  using the scikit-bio implementation of the selected beta diversity metric.

Inputs:
  --i-table ARTIFACT FeatureTable[Frequency]
                       The feature table containing the samples over which
                       beta diversity should be computed.           [required]
Parameters:
  --p-metric TEXT Choices('sokalmichener', 'dice', 'hamming', 'yule',
    'cosine', 'correlation', 'minkowski', 'cityblock', 'rogerstanimoto',
    'kulsinski', 'matching', 'canberra_adkins', 'jensenshannon',
    'sqeuclidean', 'sokalsneath', 'canberra', 'chebyshev', 'seuclidean',
    'aitchison', 'euclidean', 'russellrao')
                       The beta diversity metric to be computed.    [required]
  --p-pseudocount INTEGER
    Range(1, None)     A pseudocount to handle zeros for compositional
                       metrics. This is ignored for non-compositional metrics.
                                                                  [default: 1]
  --p-n-jobs VALUE Int % Range(1, None) | Str % Choices('auto')
                       The number of concurrent jobs to use in performing
                       this calculation. May not exceed the number of
                       available physical cores. If n-jobs = 'auto', one job
                       will be launched for each identified CPU core on the
                       host.                                      [default: 1]
Outputs:
  --o-distance-matrix ARTIFACT
    DistanceMatrix     The resulting distance 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).
  --examples           Show usage examples and exit.
  --citations          Show citations and exit.
  --help               Show this message and exit.

Import:

from qiime2.plugins.diversity_lib.methods import beta_passthrough

Docstring:

Beta Passthrough (non-phylogenetic)

Computes a distance matrix for all pairs of samples in a feature table
using the scikit-bio implementation of the selected beta diversity metric.

Parameters
----------
table : FeatureTable[Frequency]
    The feature table containing the samples over which beta diversity
    should be computed.
metric : Str % Choices('kulsinski', 'hamming', 'canberra', 'euclidean', 'aitchison', 'yule', 'sqeuclidean', 'cosine', 'canberra_adkins', 'rogerstanimoto', 'seuclidean', 'sokalmichener', 'cityblock', 'matching', 'sokalsneath', 'jensenshannon', 'chebyshev', 'correlation', 'minkowski', 'dice', 'russellrao')
    The beta diversity metric to be computed.
pseudocount : Int % Range(1, None), optional
    A pseudocount to handle zeros for compositional metrics. This is
    ignored for non-compositional metrics.
n_jobs : Int % Range(1, None) | Str % Choices('auto'), optional
    The number of concurrent jobs to use in performing this calculation.
    May not exceed the number of available physical cores. If n_jobs =
    'auto', one job will be launched for each identified CPU core on the
    host.

Returns
-------
distance_matrix : DistanceMatrix
    The resulting distance matrix.