SeuratObject (version 5.0.2)

Key: Get and set object keys

Description

Get and set object keys

Usage

Key(object, ...)
Keys(object, ...)
Key(object, ...) <- value
# S3 method for Assay
Key(object, ...)
# S3 method for Assay
Key(object, ...) <- value
# S3 method for Assay5
Key(object, ...)
# S3 method for Assay5
Key(object, ...) <- value
# S3 method for DimReduc
Key(object, ...)
# S3 method for DimReduc
Key(object, ...) <- value
# S3 method for Seurat
Key(object, ...)
# S3 method for Seurat
Keys(object, ...)

Value

Key: the object key

Keys: a named vector of keys of sub-objects

Key<-: object with an updated key

Arguments

object

An object

...

Arguments passed to other methods

value

Key value

Examples

# Get an Assay key
Key(pbmc_small[["RNA"]])

# Set the key for an Assay
Key(pbmc_small[["RNA"]]) <- "newkey_"
Key(pbmc_small[["RNA"]])

# Get a DimReduc key
Key(object = pbmc_small[["pca"]])

# Set the key for DimReduc
Key(object = pbmc_small[["pca"]]) <- "newkey2_"
Key(object = pbmc_small[["pca"]])

# Show all keys associated with a Seurat object
Key(object = pbmc_small)
Keys(object = pbmc_small)