GetNamedClusteringRuns: GetNamedClusteringRuns

View source: R/Seurat.Utils.R

GetNamedClusteringRunsR Documentation

GetNamedClusteringRuns

Description

The GetNamedClusteringRuns function retrieves metadata column names associated with non-numeric ("named") clustering runs, based on a pattern to match, "Name|name", by default.

Usage

GetNamedClusteringRuns(
  obj = combined.obj,
  res = list(FALSE, 0.5)[[1]],
  topgene = FALSE,
  pat = c("^cl.names.top.gene.+[0-9]\\.[0-9]", "Name|name")[2],
  find.alternatives = TRUE,
  v = TRUE
)

Arguments

obj

Seurat object, Default: combined.obj

res

Clustering resoluton to use, Default: c(FALSE, 0.5)1

topgene

Match clustering named after top expressed gene (see vertesy/Seurat.pipeline/~Diff gene expr.), Default: FALSE.

pat

Pattern to match, Default: '^cl.names.Known.*0,1\.0-9$'

find.alternatives

If TRUE, tries to find alternative clustering runs with the same resolution, Default: TRUE.

v

Verbose output, Default: TRUE.

Examples

## Not run: 
if (interactive()) {
  GetNamedClusteringRuns()
}

## End(Not run)

vertesy/Seurat.utils documentation built on Dec. 4, 2024, 5:20 p.m.