Skip to content

Commit efdb0fd

Browse files
authored
Zarr attributes in Rmd (#203)
1 parent 76294d4 commit efdb0fd

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

vignettes/SpatialData.Rmd

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The Python implementation and core specifications can be found at the
4444

4545
The core data structure is the `SpatialData` class, which organizes data
4646
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)
4848
Together, these layers provide a unified representation of spatial omics data,
4949
combining raster, vector, and tabular data within a single coherent framework.
5050

@@ -62,15 +62,15 @@ These are DuckDB-backed by a `duckspatial_df`, enabling efficient lazy handling.
6262
**Tables** store functional annotations or information that has been aggregated
6363
across layers (e.g., gene $\times$ cell data). They are currently represented
6464
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.
6666

6767
```{r schematic, echo=FALSE, fig.wide=TRUE}
6868
knitr::include_graphics("schematic.png")
6969
```
7070

7171
# Handling
7272

73-
`SpatialData` are represented on-disk as `.zarr` stores. The package provides
73+
`SpatialData` are represented on-disk as Zarr stores. The package provides
7474
the `readSpatialData()` function to ingest an entire store, although arguments
7575
to control which layers and elements to read or not to read are also available.
7676

@@ -81,7 +81,7 @@ For this demonstration, we use a toy dataset included in the package:
8181
library(SpatialData)
8282
library(SingleCellExperiment)
8383
84-
# path to 'spatialdata' .zarr store
84+
# path to 'spatialdata' Zarr store
8585
zs <- file.path("extdata", "blobs.zarr")
8686
zs <- system.file(zs, package="SpatialData")
8787
@@ -155,7 +155,7 @@ Every spatial element (tables excluded) is composed of two key slots:
155155
or a `duckspatial_df` for shapes/points.
156156

157157
- `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.
159159

160160
We here demonstrate how to access these slots for a given element
161161

@@ -188,7 +188,7 @@ show(d)
188188
For single-cell and spatial omics datasets, functional annotations are commonly
189189
stored as [AnnData](https://anndata.readthedocs.io) objects in Python. In R, we
190190
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).
192192

193193
A `table` can link to one or more `label` or `shape` (but not other layers),
194194
whereby internal metadata (`spatialdata_attrs`) are used to keep track of the
@@ -210,7 +210,7 @@ instances(se)
210210

211211
A key feature of the `SpatialData` framework is its handling of different
212212
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.
214214

215215
The relationships between different elements and their respective coordinate
216216
spaces can be complex. `SpatialData` provides the `CTgraph()` and `CTplot()`

0 commit comments

Comments
 (0)