BuildClusterTree | R Documentation |
Constructs a phylogenetic tree relating the 'aggregate' cell from each identity class. Tree is estimated based on a distance matrix constructed in either gene expression space or PCA space.
BuildClusterTree(
object,
assay = NULL,
features = NULL,
dims = NULL,
reduction = "pca",
graph = NULL,
slot = "data",
reorder = FALSE,
reorder.numeric = FALSE,
verbose = TRUE
)
object |
Seurat object |
assay |
Assay to use for the analysis. |
features |
Genes to use for the analysis. Default is the set of
variable genes ( |
dims |
If set, tree is calculated in dimension reduction space;
overrides |
reduction |
Name of dimension reduction to use. Only used if |
graph |
If graph is passed, build tree based on graph connectivity between
clusters; overrides |
slot |
slot/layer 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 |
Note that the tree is calculated for an 'aggregate' cell, so gene expression or PC scores are summed across all cells in an identity class before the tree is constructed.
A Seurat object where the cluster tree can be accessed with Tool
## 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)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.