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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/SpatialExperiment-assays.R
\name{SpatialExperiment-assays}
\alias{SpatialExperiment-assays}
\alias{molecules}
\alias{molecules<-}
\alias{molecules,SpatialExperiment-method}
\alias{molecules<-,SpatialExperiment-method}
\title{Methods for named assays}
\description{
The \code{\link{SpatialExperiment}} class provides methods for getting or
setting named \code{\link{assays}}. For example, \code{molecules(spe)} will
get or set an \code{assay} named \code{molecules} from object \code{spe},
equivalent to \code{assay(spe, i = "molecules")}. This provides a convenient
interface for users and encourages standardization of assay names across
packages.
}
\section{Available methods}{
In the following code, \code{spe} is a \code{\link{SpatialExperiment}}
object, \code{value} is a \code{BumpyMatrix}-like object with the same
dimensions as \code{spe}, and \code{...} are further arguments passed to
\code{\link{assay}} (for the getter) or \code{\link{assay<-}} (for the
setter).
\describe{
\item{\code{molecules(x, ...)}, \code{molecules(x, ...) <- value}:}{
Get or set an assay named \code{molecules}, which is usually assumed to be a
\code{BumpyMatrix}-formatted object containing spatial coordinates (and any
other information) of the individual molecules per gene per cell.
}
}
}
\examples{
example(SpatialExperiment)
molecules(spe_mol)
}
\seealso{
\code{\link{assay}} and \code{\link{assay<-}}
}
\author{
Dario Righelli
}
|
