forked from satijalab/seurat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathKey.Rd
63 lines (47 loc) · 1.19 KB
/
Key.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/generics.R, R/objects.R
\name{Key}
\alias{Key}
\alias{Key<-}
\alias{Key.Assay}
\alias{Key.DimReduc}
\alias{Key.Seurat}
\alias{Key.SpatialImage}
\alias{Key<-.Assay}
\alias{Key<-.DimReduc}
\alias{Key<-.SpatialImage}
\title{Get a key}
\usage{
Key(object, ...)
Key(object, ...) <- value
\method{Key}{Assay}(object, ...)
\method{Key}{DimReduc}(object, ...)
\method{Key}{Seurat}(object, ...)
\method{Key}{SpatialImage}(object, ...)
\method{Key}{Assay}(object, ...) <- value
\method{Key}{DimReduc}(object, ...) <- value
\method{Key}{SpatialImage}(object, ...) <- value
}
\arguments{
\item{object}{An object}
\item{...}{Arguments passed to other methods}
\item{value}{Key value}
}
\description{
Get a key
Set a key
}
\examples{
# Get an Assay key
Key(object = pbmc_small[["RNA"]])
# Get a DimReduc key
Key(object = pbmc_small[["pca"]])
# Show all keys associated with a Seurat object
Key(object = pbmc_small)
# Set the key for an Assay
Key(object = pbmc_small[["RNA"]]) <- "newkey_"
Key(object = pbmc_small[["RNA"]])
# Set the key for DimReduc
Key(object = pbmc_small[["pca"]]) <- "newkey2_"
Key(object = pbmc_small[["pca"]])
}