From 79705b176fc8f36f09cf8133eab07a3469894f1e Mon Sep 17 00:00:00 2001
From: Mike Smith <grimbough@gmail.com>
Date: Tue, 8 Oct 2024 11:14:34 +0200
Subject: [PATCH] Add some missing documentation entries

---
 R/ZarrArray-class.R        | 38 +++++++++++++++++++-------------------
 R/writeZarrArray.R         | 21 +++++++++++++++++++++
 man/ZarrArray-classes.Rd   |  1 +
 man/ZarrRealizationSink.Rd | 19 +++++++++++++++++++
 4 files changed, 60 insertions(+), 19 deletions(-)
 create mode 100644 man/ZarrRealizationSink.Rd

diff --git a/R/ZarrArray-class.R b/R/ZarrArray-class.R
index 6884b61..5376409 100644
--- a/R/ZarrArray-class.R
+++ b/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.
diff --git a/R/writeZarrArray.R b/R/writeZarrArray.R
index 0cfd462..cd09929 100644
--- a/R/writeZarrArray.R
+++ b/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
diff --git a/man/ZarrArray-classes.Rd b/man/ZarrArray-classes.Rd
index 5f9c23e..f798223 100644
--- a/man/ZarrArray-classes.Rd
+++ b/man/ZarrArray-classes.Rd
@@ -4,6 +4,7 @@
 \name{ZarrArray-class}
 \alias{ZarrArray-class}
 \alias{matrixClass,ZarrArray-method}
+\alias{chunkdim,ZarrArraySeed-method}
 \alias{ZarrMatrix}
 \alias{ZarrMatrix-class}
 \alias{coerce}
diff --git a/man/ZarrRealizationSink.Rd b/man/ZarrRealizationSink.Rd
new file mode 100644
index 0000000..7146f64
--- /dev/null
+++ b/man/ZarrRealizationSink.Rd
@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/writeZarrArray.R
+\name{ZarrRealizationSink}
+\alias{ZarrRealizationSink}
+\alias{writeZarrArray}
+\alias{ZarrRealizationSink-class}
+\alias{write_block,ZarrRealizationSink-method}
+\alias{type,ZarrRealizationSink-method}
+\alias{chunkdim,ZarrRealizationSink-method}
+\alias{coerce,ZarrRealizationSink,ZarrMatrix-method}
+\alias{coerce,ZarrRealizationSink,ZarrArray-method}
+\alias{coerce,ZarrRealizationSink,ZarrArraySeed-method}
+\alias{coerce,ZarrRealizationSink,DelayedArray-method}
+\alias{coerce,ANY,ZarrArray-method}
+\alias{coerce,ANY,ZarrRealizationSink-method}
+\title{Write arrays to Zarr}
+\description{
+Write array data to a Zarr backend via \pkg{DelayedArray}'s \linkS4class{RealizationSink} machinery.
+}