Meta_Present: Check if meta data are present

In samuel-marsh/scCustomize: Custom Visualizations & Functions for Streamlined Analyses of Single Cell Sequencing

Check if meta data are present

Description

Check if meta data columns are present in object and return vector of found columns Return warning messages for meta data columns not found.

Usage

Meta_Present(
  object,
  meta_col_names,
  print_msg = TRUE,
  omit_warn = TRUE,
  return_none = FALSE
)

Arguments

object	Seurat or Liger object name.
meta_col_names	vector of column names to check.
print_msg	logical. Whether message should be printed if all features are found. Default is TRUE.
omit_warn	logical. Whether to print message about features that are not found in current object. Default is TRUE.
return_none	logical. Whether list of found vs. bad features should still be returned if no meta_col_names are found. Default is FALSE.

Value

vector of meta data columns that are present

Examples

## Not run: 
meta_variables <- Meta_Present(object = obj_name, meta_col_names = "percent_mito", print_msg = TRUE)

## End(Not run)

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