Documentation updates. #93
Conversation
| @@ -243,7 +243,7 @@ require_parent_group <- function( | |||
| #' Primary compressor. | |||
There was a problem hiding this comment.
I did a ton of clean up in here. Nothing should have changed but the duplication is basically all gone. A couple check issues are taken care of here too.
| ``` | ||
|
|
||
| By default, reads and writes are performed sequentially (i.e., not in parallel). | ||
| Users can opt-in to parallel read/write functionality via `options`. | ||
|
|
||
| ```{r} | ||
| ```{r, eval=FALSE} |
There was a problem hiding this comment.
This pattern of installing is a little dubious, at least it shouldn't run when the vignette is run start to finish.
There was a problem hiding this comment.
Should we replace the install.packages with a stop() failure that suggests installation of the package?
There was a problem hiding this comment.
Probably. stop with a message saying the package should be installed is good, or if in interactive mode, it could prompt for user input?
| future::plan(future::multisession, workers = 4) | ||
|
|
||
| root <- pizzarr_sample("dog.ome.zarr") | ||
| store <- SlowDirectoryStore$new(root) | ||
| zarr_arr <- zarr_open(store = store, path = "/0") | ||
| arr <- zarr_arr$get_item("...")$data | ||
| sum(arr) | ||
|
|
||
| future::plan(oldplan) |
There was a problem hiding this comment.
CRAN and others see any change of options of other session state like par() as things that need to be cleaned up after running code.
There was a problem hiding this comment.
I see. I also see we might need to use on.exit in certain functions to ensure the cleanup happens
dblodgett-usgs
had a problem deploying
to
github-pages
GitHub Actions
Failure
| family = "Blodgett", | ||
| role = c("ctb"), | ||
| email = "dblodgett@usgs.gov", | ||
| comment = c(ORCID = "0000-0001-9489-1710")) |
There was a problem hiding this comment.
Good with this addition @keller-mark ?
| N-dimensional arrays for R. | ||
| Description: An implementation of chunked, compressed, | ||
| N-dimensional arrays for R. Zarr spec V2 (2024) | ||
| <doi:10.5281/zenodo.11320255>. |
There was a problem hiding this comment.
This is for #95
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| YEAR: 2024 | ||
| COPYRIGHT HOLDER: Mark Keller |
There was a problem hiding this comment.
Needed to do this for a CRAN check message
| @@ -80,7 +80,7 @@ ZarrArray <- R6::R6Class("ZarrArray", | |||
| #' @keywords internal | |||
| oindex = NULL, | |||
| #' @description | |||
| #' (Re)load metadata from store. | |||
| #' (Re)load metadata from store without synchronization (file locking). | |||
There was a problem hiding this comment.
I added this sort of documentation of synchronization (file locking) in a few places.
| expect_equal(bench_df$total_time[[1]] > bench_df$total_time[[2]], TRUE) | ||
| expect_equal(bench_df$total_time[[2]] > bench_df$total_time[[3]], TRUE) | ||
| }) |
There was a problem hiding this comment.
Tried to speed these tests up and also make them cran compatible.
dblodgett-usgs
had a problem deploying
to
github-pages
GitHub Actions
Failure
dblodgett-usgs
had a problem deploying
to
github-pages
GitHub Actions
Failure
dblodgett-usgs
had a problem deploying
to
github-pages
GitHub Actions
Failure
dblodgett-usgs
had a problem deploying
to
github-pages
GitHub Actions
Failure
|
Alright -- that's it from me for a bit. Need to turn to some other things next week but can keep up with messages if you have some time to push this ahead. |
dblodgett-usgs
had a problem deploying
to
github-pages
GitHub Actions
Failure
|
@keller-mark -- do you want to merge this in and start a final push for CRAN soon? |
No description provided.