BuildClusterTree: Phylogenetic Analysis of Identity Classes

In satijalab/seurat: Tools for Single Cell Genomics

Phylogenetic Analysis of Identity Classes

Description

Constructs a phylogenetic tree relating the 'average' cell from each identity class. Tree is estimated based on a distance matrix constructed in either gene expression space or PCA space.

Usage

BuildClusterTree(
  object,
  assay = NULL,
  features = NULL,
  dims = NULL,
  reduction = "pca",
  graph = NULL,
  slot = "data",
  reorder = FALSE,
  reorder.numeric = FALSE,
  verbose = TRUE
)

Arguments

object	Seurat object
assay	Assay to use for the analysis.
features	Genes to use for the analysis. Default is the set of variable genes (VariableFeatures(object = object))
dims	If set, tree is calculated in dimension reduction space; overrides features
reduction	Name of dimension reduction to use. Only used if dims is not NULL.
graph	If graph is passed, build tree based on graph connectivity between clusters; overrides dims and features
slot	(Deprecated). Slots(s) to use
reorder	Re-order identity classes (factor ordering), according to position on the tree. This groups similar classes together which can be helpful, for example, when drawing violin plots.
reorder.numeric	Re-order identity classes according to position on the tree, assigning a numeric value ('1' is the leftmost node)
verbose	Show progress updates

Details

Note that the tree is calculated for an 'average' cell, so gene expression or PC scores are averaged across all cells in an identity class before the tree is constructed.

Value

A Seurat object where the cluster tree can be accessed with Tool

Examples

## Not run: 
if (requireNamespace("ape", quietly = TRUE)) {
  data("pbmc_small")
  pbmc_small
  pbmc_small <- BuildClusterTree(object = pbmc_small)
  Tool(object = pbmc_small, slot = 'BuildClusterTree')
}

## End(Not run)

satijalab/seurat documentation built on March 20, 2024, 8:41 p.m.