runDistMat: Run distance matrix calculations

View source: R/runDistMat.R

runDistMatR Documentation

Run distance matrix calculations

Description

Performs distance matrix calculations that can be downstream used for hierarchical clustering or phylogenetic analysis. Uses amap::Dist() in order to parallelize distance calculations.

Usage

runDistMat(scCNA, metric = "euclidean", n_threads = 1)

Arguments

scCNA

scCNA object.

metric

distance metric passed to calculate the distance matrix.

n_threads

Number of threads used to calculate the distance matrix. Passed to 'amap::Dist'.

Value

A distance matrix in the slot distMat from scCNA object. Access the distance matrix with: distMat(scCNA, withDimnames = TRUE)

Author(s)

Darlan Conterno Minussi

Examples

copykit_obj <- copykit_example_filtered()[,1:10]
copykit_obj <- runDistMat(copykit_obj)

navinlabcode/copykit documentation built on Sept. 22, 2023, 9:16 a.m.