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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/coerce.R
\name{SpatialExperiment-coercion}
\alias{SpatialExperiment-coercion}
\alias{coerce,}
\alias{SingleCellExperiment,}
\alias{SpatialExperiment-method}
\alias{toSpatialExperiment}
\title{SpatialExperiment coercion methods}
\arguments{
\item{sce}{A \code{\link{SingleCellExperiment}} object.}
\item{sample_id}{A \code{character} sample identifier, which matches the
\code{sample_id} in \code{\link{imgData}}. The \code{sample_id} will also
be stored in a new column in \code{\link{colData}}, if not already present.
Default = \code{sample01}.}
\item{spatialCoordsNames}{A \code{character} vector of column names from
\code{\link{colData}} containing spatial coordinates, which will be
accessible with \code{\link{spatialCoords}}. Alternatively, the
\code{spatialCoords} argument may be provided. If both are provided,
\code{spatialCoordsNames} is given precedence, and a warning is returned.
Default = \code{c("x", "y")}.}
\item{spatialCoords}{A numeric matrix containing columns of spatial
coordinates, which will be accessible with \code{\link{spatialCoords}}.
Alternatively, \code{spatialCoordsNames} may be provided. If both are
provided, \code{spatialCoordsNames} is given precedence, and a warning is
returned.}
\item{scaleFactors}{Optional scale factors associated with the image(s). This
can be provided as a numeric value, numeric vector, list, or file path to a
JSON file for the 10x Genomics Visium platform. For 10x Genomics Visium,
the correct scale factor will automatically be selected depending on the
resolution of the image from \code{imageSources}. Default = \code{1}.}
\item{imgData}{Optional \code{\link{DataFrame}} containing the image data.
Alternatively, this can be built from the arguments \code{imageSources} and
\code{image_id} (see Details).}
\item{imageSources}{Optional file path(s) or URL(s) for one or more image
sources.}
\item{image_id}{Optional character vector (same length as
\code{imageSources}) containing unique image identifiers.}
\item{loadImage}{Logical indicating whether to load image into memory.
Default = \code{FALSE}.}
\item{spatialDataNames}{(Deprecated) A \code{character} vector of column
names from \code{\link{colData}} to include in \code{\link{spatialData}}.
Alternatively, the \code{spatialData} argument may be provided. If both are
provided, \code{spatialDataNames} is given precedence, and a warning is
returned. (Note: \code{spatialData} and \code{spatialDataNames} have been
deprecated; \code{colData} and \code{spatialCoords} should be used for all
columns. The arguments have been retained for backward compatibility but
may be removed in the future.)}
\item{spatialData}{(Deprecated) A \code{\link{DataFrame}} containing columns
to store in \code{\link{spatialData}}, which must contain at least the
columns of spatial coordinates. Alternatively, \code{spatialDataNames} may
be provided. If both are provided, \code{spatialDataNames} is given
precedence, and a warning is returned. (Note: \code{spatialData} and
\code{spatialDataNames} have been deprecated; \code{colData} and
\code{spatialCoords} should be used for all columns. The arguments have
been retained for backward compatibility but may be removed in the future.)}
}
\description{
The \code{SpatialExperiment} class inherits from the
\code{SingleCellExperiment} class making it necessary to coerce between these
classes.
To do so, we designed two different methods: the traditional \code{as} method
and the \code{toSpatialExperiment} function (recommended).
The \code{as} method checks if the \code{SingleCellExperiment} object has
already populated \code{int_colData} with three elements:
\code{spatialData}, \code{spatialCoords}, and \code{imgData}.
It also checks if \code{colData} already contains a \code{sample_id}.
In case these checks pass the new \code{SpatialExperiment} will have the same
values as the \code{SingleCellExperiment} passed object.
Otherwise a \code{SpatialExperiment} with default values for these slots
will be created.
The \code{toSpatialExperiment} method expects a \code{SingleCellExperiment} object
and additional arguments as explained in the related section of this
documentation. In case the \code{SingleCellExperiment} object has already
populated \code{int_colData} with \code{spatialData} and/or
\code{spatialCoords} and/or \code{imgData}, these will be respectively
overwritten in case the arguments \code{spatialData}/\code{spatialDataNames}
and/or \code{spatialCoords}/\code{spatialCoordsNames} and/or \code{imgData}
are not \code{NULL}.
}
\examples{
dir <- system.file(
file.path("extdata", "10xVisium", "section1", "outs"),
package = "SpatialExperiment")
# read in counts
fnm <- file.path(dir, "raw_feature_bc_matrix")
sce <- DropletUtils::read10xCounts(fnm)
# read in spatial coordinates
fnm <- file.path(dir, "spatial", "tissue_positions_list.csv")
xyz <- read.csv(fnm, header = FALSE,
col.names = c("barcode", "in_tissue", "array_row", "array_col",
"pxl_row_in_fullres", "pxl_col_in_fullres"))
# read in image data
img <- readImgData(
path = file.path(dir, "spatial"),
sample_id = "sample01")
## as method
(spe <- as(sce, "SpatialExperiment"))
colData(sce) <- DataFrame(xyz[,c(1:4)])
int_colData(sce)$spatialCoords <- as.matrix(xyz[,c(5,6)])
## Coercing an sce without imgData
(spe <- as(sce, "SpatialExperiment"))
## Coercing an sce with imgData
int_colData(sce)$imgData <- img
(spe <- as(sce, "SpatialExperiment"))
## toSpatialExperiment method
colData(sce) <- DataFrame(xyz)
(spe <- toSpatialExperiment(sce,
imgData = img,
spatialCoordsNames = c("pxl_col_in_fullres", "pxl_row_in_fullres"),
sample_id = "sample01"))
}
|
