Beta diversity correlation
Create a distance matrix from a numeric metadata column and apply a two-
sided Mantel test to identify correlation between two distance matrices.
Actions used internally: distance-matrix from q2-metadata and mantel
from q2-diversity.
Parameters
- metadata : MetadataColumn[Numeric]
- Numeric metadata column from which to compute pairwise Euclidean
distances
- distance_matrix : DistanceMatrix
- Matrix of distances between pairs of samples.
- method : Str % Choices('spearman', 'pearson'), optional
- The correlation test to be applied in the Mantel test.
- permutations : Int % Range(0, None), optional
- The number of permutations to be run when computing p-values. Supplying
a value of zero will disable permutation testing and p-values will not
be calculated (this results in much quicker execution time if
p-values are not desired).
- intersect_ids : Bool, optional
- If supplied, IDs that are not found in both distance matrices will be
discarded before applying the Mantel test. Default behavior is to error
on any mismatched IDs.
- label1 : Str, optional
- Label for distance_matrix in the output visualization.
- label2 : Str, optional
- Label for metadata_distance_matrix in the output visualization.
Returns
- metadata_distance_matrix : DistanceMatrix
- The Distance Matrix produced from the metadata column and used in the
mantel test
- mantel_scatter_visualization : Visualization
- Scatter plot rendering of the manteltest results