AverageDistance: Calculates the average distance between groups for a list of...

Description Usage Arguments Value

View source: R/distance.R

Description

The average distance is the average of the distance from every individual cell in group 1 to every individual cell in group 2.

Usage

1
2
3
AverageDistance(seurat_object, group, reduction = "pca", dims = 1:30,
  distance = "euclidian", split_by = NULL, output = "seurat",
  parallel = FALSE)

Arguments

seurat_object

A seurat object

group

Seurat Categories or groups for which the distances between are calculated. Cell wise data.

reduction

Dimensionality reduction data to use

dims

Which dimensions to use

distance

Point to point distance to use. Options are "euclidean", "maximum", "manhattan", "canberra", "binary", "minkowski"

split_by

Second seurat category to split the calculations over.

output

Output type. Default is "seurat". Options are "seurat" (Seurat S4 object), "list" (List of tables by split_by), "seurat_list" (List of Seurat objects). Seurat objects returned have the distance data stored internally.

parallel

It is possible to run this process in parallel across multiple computers using BiocParallel. TRUE will use and FALSE will not. If this is set to TRUE then it will not be able to print out progress.

Value

Average distance data. Fundementally in the form of a vector of distances


sbrn3/disscat documentation built on Dec. 12, 2019, 7:54 a.m.