You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: vignettes/SpatialData.Rmd
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ The Python implementation and core specifications can be found at the
44
44
45
45
The core data structure is the `SpatialData` class, which organizes data
46
46
into 5 coordinated **layers: images, labels, points, shapes, and tables**.
47
-
Each layer is stored as a list of layer-specific objects that carry associated `SpatialDataAttr` (`@meta` slot), which encode `spatialdata`-specific *.zattr*.
47
+
Each layer is stored as a list of layer-specific objects that carry associated `SpatialDataAttr` (`@meta` slot), which encode `spatialdata`-specific zarr attributes (*.zattr* for Zarr v2, and *zarr.json* for Zarr v3)
48
48
Together, these layers provide a unified representation of spatial omics data,
49
49
combining raster, vector, and tabular data within a single coherent framework.
50
50
@@ -62,15 +62,15 @@ These are DuckDB-backed by a `duckspatial_df`, enabling efficient lazy handling.
62
62
**Tables** store functional annotations or information that has been aggregated
63
63
across layers (e.g., gene $\times$ cell data). They are currently represented
64
64
as in-memory `r BiocStyle::Biocpkg("SingleCellExperiment")` objects; delayed,
65
-
*.zarr*-backed handling of assay data is under active development.
65
+
Zarr-backed handling of assay data is under active development.
66
66
67
67
```{r schematic, echo=FALSE, fig.wide=TRUE}
68
68
knitr::include_graphics("schematic.png")
69
69
```
70
70
71
71
# Handling
72
72
73
-
`SpatialData` are represented on-disk as `.zarr` stores. The package provides
73
+
`SpatialData` are represented on-disk as Zarr stores. The package provides
74
74
the `readSpatialData()` function to ingest an entire store, although arguments
75
75
to control which layers and elements to read or not to read are also available.
76
76
@@ -81,7 +81,7 @@ For this demonstration, we use a toy dataset included in the package:
81
81
library(SpatialData)
82
82
library(SingleCellExperiment)
83
83
84
-
# path to 'spatialdata' .zarr store
84
+
# path to 'spatialdata' Zarr store
85
85
zs <- file.path("extdata", "blobs.zarr")
86
86
zs <- system.file(zs, package="SpatialData")
87
87
@@ -155,7 +155,7 @@ Every spatial element (tables excluded) is composed of two key slots:
155
155
or a `duckspatial_df` for shapes/points.
156
156
157
157
-`meta`: a `SpatialDataAttrs` object containing the OME-NGFF metadata
158
-
retrieved from the *.zattrs*present in the original *.zarr* store.
158
+
retrieved from the zarr attributes present in the original Zarr store.
159
159
160
160
We here demonstrate how to access these slots for a given element
161
161
@@ -188,7 +188,7 @@ show(d)
188
188
For single-cell and spatial omics datasets, functional annotations are commonly
189
189
stored as [AnnData](https://anndata.readthedocs.io) objects in Python. In R, we
190
190
use `r BiocStyle::Biocpkg("anndataR")`[@Deconinck2025-anndataR] to read these
191
-
`.zarr`-backed `AnnData` as `r BiocStyle::Biocpkg("SingleCellExperiment")`(s).
191
+
Zarr-backed `AnnData` as `r BiocStyle::Biocpkg("SingleCellExperiment")`(s).
192
192
193
193
A `table` can link to one or more `label` or `shape` (but not other layers),
194
194
whereby internal metadata (`spatialdata_attrs`) are used to keep track of the
@@ -210,7 +210,7 @@ instances(se)
210
210
211
211
A key feature of the `SpatialData` framework is its handling of different
212
212
coordinate systems. Each element can exist in multiple coordinate spaces
213
-
simultaneously, defined by transformations in its on-disk *.zattrs*.
213
+
simultaneously, defined by transformations in its on-disk Zarr attributes.
214
214
215
215
The relationships between different elements and their respective coordinate
216
216
spaces can be complex. `SpatialData` provides the `CTgraph()` and `CTplot()`
0 commit comments