Skip to content

Commit

Permalink
importFrom for %dopar%; update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
keller-mark committed Jun 20, 2024
1 parent 7478064 commit 4b3db37
Show file tree
Hide file tree
Showing 16 changed files with 116 additions and 24 deletions.
9 changes: 2 additions & 7 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export(is_key_error)
export(is_scalar)
export(is_slice)
export(obj_list)
export(pizzarr_option_defaults)
export(pizzarr_sample)
export(slice)
export(zarr_create)
Expand All @@ -39,10 +40,4 @@ export(zarr_open_array)
export(zarr_open_group)
export(zarr_save_array)
export(zb_slice)
importFrom(R6,R6Class)
importFrom(memoise,memoise)
importFrom(memoise,timeout)
importFrom(qs,lz4_compress_raw)
importFrom(qs,lz4_decompress_raw)
importFrom(qs,zstd_compress_raw)
importFrom(qs,zstd_decompress_raw)
importFrom(foreach,"%dopar%")
10 changes: 4 additions & 6 deletions R/numcodecs.R
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ Codec <- R6::R6Class("Codec",
#' ZSTD compressor for Zarr
#' @title ZstdCodec Class
#' @docType class
#' @importFrom qs zstd_compress_raw zstd_decompress_raw
#' @description
#' Class representing a ZSTD compressor

Expand All @@ -62,7 +61,7 @@ ZstdCodec <- R6::R6Class("ZstdCodec",
#' @return Compressed data.
encode = function(buf, zarr_arr) {
# Reference: https://github.com/traversc/qs/blob/84e30f4/R/RcppExports.R#L16
result <- zstd_compress_raw(buf, self$level)
result <- qs::zstd_compress_raw(buf, self$level)
return(result)
},
#' @description
Expand All @@ -71,7 +70,7 @@ ZstdCodec <- R6::R6Class("ZstdCodec",
#' @param zarr_arr The ZarrArray instance.
#' @return Un-compressed data.
decode = function(buf, zarr_arr) {
result <- zstd_decompress_raw(buf)
result <- qs::zstd_decompress_raw(buf)
return(result)
},
#' @description
Expand All @@ -89,7 +88,6 @@ ZstdCodec <- R6::R6Class("ZstdCodec",
#' LZ4 compressor for Zarr
#' @title Lz4Codec Class
#' @docType class
#' @importFrom qs lz4_compress_raw lz4_decompress_raw
#' @description
#' Class representing a LZ4 compressor
#'
Expand All @@ -115,7 +113,7 @@ Lz4Codec <- R6::R6Class("Lz4Codec",
#' @return Compressed data.
encode = function(buf, zarr_arr) {
# Reference: https://github.com/traversc/qs/blob/84e30f4/R/RcppExports.R#L24
body <- lz4_compress_raw(buf, self$acceleration)
body <- qs::lz4_compress_raw(buf, self$acceleration)

# The compressed output includes a 4-byte header storing the original size
# of the decompressed data as a little-endian 32-bit integer.
Expand All @@ -135,7 +133,7 @@ Lz4Codec <- R6::R6Class("Lz4Codec",
decode = function(buf, zarr_arr) {
body <- buf[5:length(buf)]

result <- lz4_decompress_raw(body)
result <- qs::lz4_decompress_raw(body)
return(result)
},
#' @description
Expand Down
4 changes: 1 addition & 3 deletions R/options.R
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# Adapted from https://github.com/IRkernel/IRkernel/blob/master/R/options.r

#' @usage
#' pizzarr_option_defaults
#'
#' @rdname pizzarr-package
#' @export
pizzarr_option_defaults <- list(
pizzarr.http_store_cache_time_seconds = 3600,
pizzarr.parallel_read_enabled = FALSE,
pizzarr.parallel_write_enabled = FALSE
)

#' @keywords internal
from_env <- list(
PIZZARR_HTTP_STORE_CACHE_TIME_SECONDS = as.integer,
PIZZARR_PARALLEL_READ_ENABLED = as.logical,
Expand Down
1 change: 0 additions & 1 deletion R/stores.R
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,6 @@ MemoryStore <- R6::R6Class("MemoryStore",
#' HttpStore for Zarr
#' @title HttpStore Class
#' @docType class
#' @importFrom memoise memoise timeout
#' @description
#' Store class that uses HTTP requests.
#' Read-only. Depends on the `crul` package.
Expand Down
2 changes: 1 addition & 1 deletion R/zarr-array.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#' The Zarr Array class.
#' @title ZarrArray Class
#' @docType class
#' @importFrom R6 R6Class
#' @importFrom foreach %dopar%
#' @description
#' Instantiate an array from an initialized store.
#' @param selection Selections are lists containing either scalars, strings, or Slice objects. Two character
Expand Down
8 changes: 7 additions & 1 deletion man/ZarrArray.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion man/as_scalar.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions man/ensure_integer_vec.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions man/ensure_list.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions man/is_integer.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions man/is_integer_list.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions man/is_integer_scalar.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions man/is_integer_vec.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/is_scalar.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions man/pizzarr_option_defaults.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/zb_slice.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4b3db37

Please sign in to comment.