scCustomize (version 3.1.3)

Cluster_Stats_All_Samples: Calculate Cluster Stats

Description

Calculates both overall and per sample cell number and percentages per cluster based on orig.ident.

Usage

Cluster_Stats_All_Samples(
  seurat_object,
  group_by_var = deprecated(),
  group.by = "orig.ident",
  order_by_freq = TRUE
)

Value

A data.frame with rows in order of frequency or cluster order

Arguments

seurat_object

Seurat object name.

group_by_var

soft-deprecated. See group.by.

group.by

meta data column to classify samples (default = "orig.ident").

order_by_freq

logical, whether the data.frame should be ordered by frequency of identity (default; TRUE), or by cluster/fector order (FALSE).

Examples

if (FALSE) {
stats <- Cluster_Stats_All_Samples(seurat_object = object, group.by = "orig.ident")
}