Case_Check: Check for alternate case features

View source: R/Utilities.R

Case_CheckR Documentation

Check for alternate case features

Description

Checks Seurat object for the presence of features with the same spelling but alternate case.

Usage

Case_Check(
  seurat_object,
  gene_list,
  case_check_msg = TRUE,
  return_features = TRUE,
  assay = NULL
)

Arguments

seurat_object

Seurat object name.

gene_list

vector of genes to check.

case_check_msg

logical. Whether to print message to console if alternate case features are found in addition to inclusion in returned list. Default is TRUE.

return_features

logical. Whether to return vector of alternate case features. Default is TRUE.

assay

Name of assay to pull feature names from. If NULL will use the result of DefaultAssay(seurat_object).

Value

If features found returns vector of found alternate case features and prints message depending on parameters specified.

Examples

## Not run: 
alt_features <- Case_Check(seurat_object = obj_name, gene_list = DEG_list)

## End(Not run)


samuel-marsh/scCustomize documentation built on Dec. 20, 2024, 7:41 a.m.