getCellIDs.from.meta: getCellIDs.from.meta

View source: R/Seurat.Utils.Metadata.R

getCellIDs.from.metaR Documentation

getCellIDs.from.meta

Description

Retrieves cell IDs from a specified metadata column of a Seurat object, where the cell ID matches a provided list of values. The matching operation uses the %in% operator.

Usage

getCellIDs.from.meta(
  ident = GetClusteringRuns()[1],
  ident_values = NA,
  obj = combined.obj,
  inverse = FALSE
)

Arguments

ident

A string specifying the name of the metadata column from which to retrieve cell IDs. Default: 'res.0.6'.

ident_values

A vector of values to match in the metadata column. Default: NA.

obj

The Seurat object from which to retrieve the cell IDs. Default: combined.obj.

inverse

A boolean value indicating whether to inverse the match, i.e., retrieve cell IDs that do not match the provided list of ident_values. Default: FALSE.

Value

A vector of cell IDs that match (or don't match, if inverse = TRUE) the provided list of values.

Examples

## Not run: 
if (interactive()) {
  # Example usage:
  getCellIDs.from.meta()
}

## End(Not run)

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