addGeneClassFractions: Add Meta Data for Gene-Class Fractions

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

addGeneClassFractionsR Documentation

Add Meta Data for Gene-Class Fractions

Description

This function adds meta data for various gene-class fractions such as percent.mito, percent.ribo, percent.AC.GenBank, percent.AL.EMBL, percent.LINC, percent.MALAT1, and percent.HGA to a Seurat object. If the meta data already exists, a message will be displayed.

Usage

addGeneClassFractions(
  obj,
  gene_fractions = list(percent.mito = "^MT\\.|^MT-", percent.ribo = "^RPL|^RPS",
    percent.AC.GenBank = "^AC[0-9]{6}\\.", percent.AL.EMBL = "^AL[0-9]{6}\\.",
    percent.LINC = "^LINC0", percent.MALAT1 = "^MALAT1"),
  add_hga = TRUE
)

Arguments

obj

A Seurat object to be updated. Default: None.

gene_fractions

A named list containing gene symbol patterns for each meta column name. Default: List of predefined gene fractions.

add_hga

A logical value indicating whether to add percent.HGA meta data. Default: TRUE.

Value

An updated Seurat object.


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