AddMetaData: Add in metadata associated with either cells or features.

In atakanekiz/Seurat3.0: Tools for Single Cell Genomics

Description

Adds additional data to the object. Can be any piece of information associated with a cell (examples include read depth, alignment rate, experimental batch, or subpopulation identity) or feature (ENSG name, variance). To add cell level information, add to the Seurat object. If adding feature-level metadata, add to the Assay object (e.g. object[["RNA"]]))

Usage

AddMetaData(object, metadata, col.name = NULL)

## S3 method for class 'Assay'
AddMetaData(object, metadata, col.name = NULL)

## S3 method for class 'Seurat'
AddMetaData(object, metadata, col.name = NULL)

## S4 replacement method for signature 'Assay'
x[[i, j, ...]] <- value

## S4 replacement method for signature 'Seurat'
x[[i, j, ...]] <- value

Arguments

x, object	An object
i, col.name	Name to store metadata or object as
j	Ignored
...	Arguments passed to other methods
value, metadata	Metadata or object to add

Value

An object with metadata or and object added

Examples

cluster_letters <- LETTERS[Idents(object = pbmc_small)]
names(cluster_letters) <- colnames(x = pbmc_small)
pbmc_small <- AddMetaData(
  object = pbmc_small,
  metadata = cluster_letters,
  col.name = 'letter.idents'
)
head(x = pbmc_small[[]])

atakanekiz/Seurat3.0 documentation built on May 26, 2019, 2:33 a.m.