addMeta: Add a metadata to be included in the shiny app

View source: R/addMeta.R

addMetaR Documentation

Add a metadata to be included in the shiny app

Description

Add a metadata to be included in the shiny app.

Usage

addMeta(scConf, meta.to.add, obj, maxLevels = 50)

Arguments

scConf

shinycell config data.table

meta.to.add

metadata to add from the single-cell metadata. Must match one of the following:

  • Seurat objects: column names in seu@meta.data i.e. colnames(seu@meta.data)

  • SCE objects: column names in sce@colData i.e. colnames(sce@colData)

  • h5ad files: column names in h5ad.obs i.e. h5ad.obs.columns.values

  • loom files: column names in loom/col_attrs i.e. loom/col_attrs.names

obj

input single-cell object for Seurat (v3+) / SingleCellExperiment data or input file path for h5ad / loom files

maxLevels

maximum number of levels allowed for categorical metadata. Metadata with nlevels > maxLevels will throw up an error message

Value

updated shinycell config data.table

Author(s)

John F. Ouyang

Examples

scConf = addMeta(scConf, c("orig.ident"), seu)


SGDDNB/ShinyCell documentation built on Jan. 25, 2024, 3:19 p.m.