Zarr support

.gitignore

@@ -60,4 +60,4 @@ rsconnect/
 vignettes/data/*.h5ad
 /doc/
 /Meta/
-/data/
+/data/

DESCRIPTION

@@ -49,6 +49,7 @@ Suggests:
     knitr,
     processx,
     rhdf5 (>= 2.52.1),
+    Rarr,
     rmarkdown,
     S4Vectors,
     Seurat,

NAMESPACE

@@ -17,7 +17,9 @@ export(as_AnnData)
 export(generate_dataset)
 export(get_generator_types)
 export(read_h5ad)
+export(read_zarr)
 export(write_h5ad)
+export(write_zarr)
 importFrom(Matrix,as.matrix)
 importFrom(Matrix,sparseMatrix)
 importFrom(Matrix,t)
@@ -35,3 +37,4 @@ importFrom(reticulate,r_to_py)
 importFrom(rlang,`%||%`)
 importFrom(rlang,caller_env)
 importFrom(stats,setNames)
+importFrom(utils,tail)

R/AbstractAnnData.R

@@ -287,6 +287,28 @@ AbstractAnnData <- R6::R6Class(
       )
     },
     #' @description
+    #' Convert to a [`ZarrAnnData`]
+    #'
+    #' See [as_ZarrAnnData()] for more details on the conversion
+    #'
+    #' @param file See [as_ZarrAnnData()]
+    #' @param compression See [as_ZarrAnnData()]
+    #' @param mode See [as_ZarrAnnData()]
+    #'
+    #' @return A [`ZarrAnnData`] object
+    as_ZarrAnnData = function(
+      file,
+      compression = c("none", "gzip"),
+      mode = c("w-", "r", "r+", "a", "w", "x")
+    ) {
+      as_ZarrAnnData(
+        adata = self,
+        file = file,
+        compression = compression,
+        mode = mode
+      )
+    },
+    #' @description
     #' Write the `AnnData` object to an H5AD file
     #'
     #' See [write_h5ad()] for details
@@ -302,6 +324,24 @@ AbstractAnnData <- R6::R6Class(
       mode = c("w-", "r", "r+", "a", "w", "x")
     ) {
       write_h5ad(object = self, path, compression = compression, mode = mode)
+    },
+    #' @description
+    #' Write the `AnnData` object to a Zarr file
+    #'
+    #' See [write_zarr()] for details
+    #'
+    #' @param path See [write_zarr()]
+    #' @param compression See [write_zarr()]
+    #' @param mode See [write_zarr()]
+    #'
+    #' @return `path` invisibly
+    write_zarr = function(
+      path,
+      compression = c("none", "gzip", "blosc", "zstd", 
+                      "lzma", "bz2", "zlib", "lz4"),
+      mode = c("w-", "r", "r+", "a", "w", "x")
+    ) {
+      write_zarr(object = self, path, compression = compression, mode = mode)
     }
   ),
   private = list(

R/AnnData-usage.R

@@ -13,6 +13,7 @@
 #'
 #' - [InMemoryAnnData] stores data in memory
 #' - [HDF5AnnData] provides an interface to a H5AD file
+#' - [ZarrAnnData] provides an interface to a H5AD file
 #' - [ReticulateAnnData] wraps a Python `AnnData` object via \pkg{reticulate}
 #'
 #' See the class documentation for details.
@@ -89,6 +90,7 @@
 #'   \item{`as_Seurat()`}{Convert to [`SeuratObject::Seurat`], see [as_Seurat()]}
 #'   \item{`as_InMemoryAnnData()`}{Convert to [`InMemoryAnnData`], as [as_InMemoryAnnData()]}
 #'   \item{`as_HDF5AnnData()`}{Convert to [`HDF5AnnData`], see [as_HDF5AnnData()]}
+#'   \item{`as_ZarrAnnData()`}{Convert to [`ZarrAnnData`], see [as_ZarrAnnData()]}
 #'   \item{`as_ReticulateAnnData()`}{Convert to [`ReticulateAnnData`], see [as_ReticulateAnnData()]}
 #' }
 #'
@@ -101,6 +103,14 @@
 #'     Write the `AnnData` object to an HDF5 file, see [write_h5ad()]
 #'   }
 #' }
+#' 
+#' \describe{
+#'   \item{
+#'     `write_zarr()`
+#'   }{
+#'     Write the `AnnData` object to a Zarr store, see [write_zarr()]
+#'   }
+#' }
 #'
 #' ## General methods:
 #'
@@ -112,7 +122,8 @@
 #'
 #' \describe{
 #'   \item{[AnnData()]}{Create an [InMemoryAnnData] object}
-#'   \item{[read_h5ad()]}{Read an `AnnData` from a H5AD file}
+#'   \item{[read_h5ad()]}{Read an `AnnData` from an H5AD file}
+#'   \item{[read_zarr()]}{Read an `AnnData` from a Zarr store}
 #'   \item{[as_AnnData()]}{Convert other objects to an `AnnData` object}
 #' }
 #'
@@ -122,6 +133,7 @@
 #'   inherit from
 #' @seealso [InMemoryAnnData] for the in-memory implementation of `AnnData`
 #' @seealso [HDF5AnnData] for the HDF5-backed implementation of `AnnData`
+#' @seealso [ZarrAnnData] for the Zarr-backed implementation of `AnnData`
 #' @seealso [ReticulateAnnData] for the reticulate-based implementation that wraps Python AnnData objects
 #'
 #' @name AnnData-usage

R/Rarr_utils.R

@@ -0,0 +1,111 @@
+#' create_zarr_group
+#'
+#' Create a zarr group
+#'
+#' @param store the location of (zarr) store
+#' @param name name of the group
+#' @param version zarr version
+#'
+#' @return `NULL`
+#'
+#' @noRd
+#'
+#' @examples
+#' store <- tempfile(fileext = ".zarr")
+#' create_zarr(store)
+#' create_zarr_group(store, "gp")
+create_zarr_group <- function(store, name, version = "v2") {
+  split_name <- strsplit(name, split = "/", fixed = TRUE)[[1]]
+  if (length(split_name) > 1) {
+    split_name <- vapply(
+      seq_along(split_name),
+      function(x) paste(split_name[seq_len(x)], collapse = "/"),
+      FUN.VALUE = character(1)
+    )
+    split_name <- rev(tail(split_name, 2))
+    if (!dir.exists(file.path(store, split_name[2]))) {
+      create_zarr_group(store = store, name = split_name[2])
+    }
+  }
+  dir.create(file.path(store, split_name[1]), showWarnings = FALSE)
+  switch(
+    version,
+    v2 = {
+      write(
+        "{\"zarr_format\":2}",
+        file = file.path(store, split_name[1], ".zgroup")
+      )
+    },
+    v3 = {
+      cli_abort("Currently only zarr v2 is supported!")
+    },
+    cli_abort("Only zarr v2 is supported. Use version = 'v2'")
+  )
+}
+
+#' create_zarr
+#'
+#' Create zarr store
+#'
+#' @param store the location of zarr store
+#' @param version zarr version
+#'
+#' @return `NULL`
+#'
+#' @noRd
+#'
+#' @examples
+#' store <- tempfile(fileext = ".zarr")
+#' create_zarr(store)
+create_zarr <- function(store, version = "v2") {
+  prefix <- basename(store)
+  dir <- gsub(paste0(prefix, "$"), "", store)
+  create_zarr_group(store = dir, name = prefix, version = version)
+}
+
+#' is_zarr_empty
+#'
+#' check if a zarr store is empty or not.
+#'
+#' @param store the location of zarr store
+#'
+#' @return returns TRUE if zarr store is empty
+#'
+#' @noRd
+#'
+#' @examples
+#' store <- tempfile(fileext = ".zarr")
+#' create_zarr(store)
+#' is_zarr_empty(store)
+is_zarr_empty <- function(store) {
+  files <- list.files(store, recursive = FALSE, full.names = FALSE)
+  all(files %in% c(".zarray", ".zattrs", ".zgroup"))
+}
+
+#' Zarr path exists
+#'
+#' Check that a path in Zarr exists
+#'
+#' @return Whether the `target_path` exists in `store`
+#' @noRd
+#'
+#' @param store Path to a Zarr store
+#' @param target_path The path within the store to test for
+zarr_path_exists <- function(store, target_path) {
+  zarr <- file.path(store, target_path)
+  if (!dir.exists(zarr)) {
+    FALSE
+  } else {
+    list_files <- list.files(
+      path = zarr,
+      full.names = FALSE,
+      recursive = FALSE,
+      all.files = TRUE
+    )
+    if (any(c(".zarray", ".zattrs", ".zgroup") %in% list_files)) {
+      TRUE
+    } else {
+      FALSE
+    }
+  }
+}