skbio.diversity.beta_diversity¶
- skbio.diversity.beta_diversity(metric, counts, ids=None, validate=True, pairwise_func=None, **kwargs)[源代码]¶
计算所有样本对之间的距离
状态:从0.4.0开始实验。
- 参数:
metric (str, callable) -- 要应用的成对距离函数。查看
pdist
docs和 scikit-bio 函数链接到 也见 获取可用指标。最好将度量作为字符串传递,因为这通常会导致使用度量的优化版本。counts (2D array_like of ints or floats or 2D pandas DataFrame) -- 包含计数/丰度数据的矩阵,其中每行包含给定样本中OTU的计数。
ids (iterable of strs, optional) -- 中每个样本的标识符
counts
. 默认情况下,将按照提供的顺序为样本分配整数标识符(其中标识符的类型为str
)validate (bool, optional) -- 如果 False ,将不执行输入验证。此步骤可能很慢,因此如果在其他地方运行验证,则可以在此处禁用它。但是,无效的输入数据可能导致无效的结果或难以解释的错误消息,因此如果您不确定输入数据是否有效,则不应跳过此步骤。看到了吗
skbio.diversity
有关验证所需内容的说明,以便确定是否可以安全地禁用验证。pairwise_func (callable, optional) -- 用于计算成对距离的函数。此函数必须采用
counts
和metric
并返回正方形、中空的2-Dnumpy.ndarray
不同之处(浮动)。可以提供的功能示例如下scipy.spatial.distance.pdist
和sklearn.metrics.pairwise_distances
。默认情况下,scipy.spatial.distance.pdist
将会被使用。kwargs (kwargs, optional) -- 公制特定参数。
- 返回:
所有成对样本(即行)之间的距离。行数和列数将等于中的行数
counts
.- 返回类型:
skbio.DistanceMatrix
- 抛出:
ValueError, MissingNodeError, DuplicateNodeError -- 如果验证失败。确切的错误将取决于什么是无效的。
TypeError -- 如果提供了无效的方法特定参数。
参见
skbio.diversity
,skbio.diversity.beta
,skbio.diversity.get_beta_diversity_metrics
,skbio.diversity.alpha_diversity
,scipy.spatial.distance.pdist
,sklearn.metrics.pairwise_distances