Add some missing documentation entries

R/ZarrArray-class.R

@@ -54,30 +54,30 @@ ZarrArraySeed <- function(zarr_array_path) {
   )
 }
 
-.validate_ZarrArraySeed <- function(x) {
-
-  ## 'dim' slot.
-  msg <- S4Arrays:::validate_dim_slot(x, "dim")
-  if (!isTRUE(msg))
-    return(msg)
-
-  ## 'chunkdim' slot.
-  x_chunkdim <- x@chunk_dim
-  if (!is.null(x_chunkdim)) {
-    msg <- S4Arrays:::validate_dim_slot(x, "chunk_dim")
-    if (!isTRUE(msg))
-      return(msg)
-  }
-
-}
-
-setValidity2("ZarrArraySeed", .validate_ZarrArraySeed)
+# .validate_ZarrArraySeed <- function(x) {
+#   
+#   ## 'dim' slot.
+#   msg <- S4Arrays:::validate_dim_slot(x, "dim")
+#   if (!isTRUE(msg))
+#     return(msg)
+#   
+#   ## 'chunkdim' slot.
+#   x_chunkdim <- x@chunk_dim
+#   if (!is.null(x_chunkdim)) {
+#     msg <- S4Arrays:::validate_dim_slot(x, "chunk_dim")
+#     if (!isTRUE(msg))
+#       return(msg)
+#   }
+#   
+# }
+# 
+# setValidity2("ZarrArraySeed", .validate_ZarrArraySeed)
 
 ### --------------------------------
 ### ZarrArray and ZarrMatrix objects
 ### --------------------------------
 
-#' @aliases ZarrArray-class matrixClass,ZarrArray-method
+#' @aliases ZarrArray-class matrixClass,ZarrArray-method chunkdim,ZarrArraySeed-method
 #' @rdname ZarrArray-classes
 #'
 #' @param zarr_array_path Path to a Zarr array. A character vector of length 1.

R/writeZarrArray.R

@@ -3,6 +3,27 @@
 ### -------------------------------------------------------------------------
 ###
 
+#' Write arrays to Zarr 
+#'
+#' Write array data to a Zarr backend via \pkg{DelayedArray}'s \linkS4class{RealizationSink} machinery.
+#' 
+#' @aliases
+#' writeZarrArray
+#' ZarrRealizationSink
+#' ZarrRealizationSink-class
+#' write_block,ZarrRealizationSink-method
+#' type,ZarrRealizationSink-method
+#' chunkdim,ZarrRealizationSink-method
+#' coerce,ZarrRealizationSink,ZarrMatrix-method
+#' coerce,ZarrRealizationSink,ZarrArray-method
+#' coerce,ZarrRealizationSink,ZarrArraySeed-method
+#' coerce,ZarrRealizationSink,DelayedArray-method
+#' coerce,ANY,ZarrArray-method
+#' coerce,ANY,ZarrRealizationSink-method
+#'
+#' @name ZarrRealizationSink
+NULL
+
 
 ### - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ### ZarrRealizationSink objects