ropensci / software-review

rOpenSci Software Peer Review.
286 stars 104 forks source link

Presubmission inquiry: `chopin` #630

Closed sigmafelix closed 4 months ago

sigmafelix commented 4 months ago

Submitting Author Name: Insang Song Submitting Author Github Handle: !--author1-->@sigmafelix<!--end-author1-- Other Package Authors Github handles: (comma separated, delete if none) !--author-others-->@Spatiotemporal-Exposures-and-Toxicology<!--end-author-others-- Repository: https://github.com/Spatiotemporal-Exposures-and-Toxicology/chopin Submission type: Pre-submission Language: en


Package: chopin
Title: CHOPIN: Computation for Climate and Health research On Parallelized INfrastructure
Version: 0.4.0.20240222
Authors@R: c(
    person("Insang", "Song", , "geoissong@gmail.com", role = c("aut", "cre"),
           comment = c(ORCID = "0000-0001-8732-3256")),
    person("Kyle", "Messier", role = c("aut", "ctb"),
           comment = c(ORCID = "0000-0001-9508-9623"))
  )
Description: It enables users with basic understanding on geospatial data
    and sf and terra functions to parallelize geospatial operations for
    geospatial exposure assessment modeling and covariate computation.
    Parallelization is done by dividing large datasets into sub-regions
    with regular grids and data's own hierarchy. A computation over the
    large number of raster files can be parallelized with a chopin
    function as well.
License: MIT + file LICENSE
URL: https://github.com/Spatiotemporal-Exposures-and-Toxicology/chopin
BugReports: 
    https://github.com/Spatiotemporal-Exposures-and-Toxicology/chopin/issues
Depends: 
    R (>= 4.1)
Encoding: UTF-8
LazyData: true
LazyDataCompression: xz
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
Imports: 
    doFuture,
    dplyr (>= 1.1.0),
    exactextractr (>= 0.8.2),
    future,
    future.apply,
    methods,
    rlang (>= 0.4.9),
    sf (>= 1.0-10),
    stars (>= 0.6-0),
    terra (>= 1.7-18)
Suggests: 
    covr,
    doParallel,
    future.batchtools,
    igraph,
    knitr,
    rmarkdown,
    testthat (>= 3.0.0),
    units,
    withr
VignetteBuilder: knitr
Config/testthat/edition: 3
LitrVersionUsed: 0.9.0
LitrId: 65b64b88def74fbb9156429f0cf0d122

Scope

: This package automates parallelization in spatial operations with chopin macros as well as sf/terra functions. It helps users to leverage maximal computing assets to expedite geospatial exposure assessment.

: Not applicable

: Spatial epidemiologists and health geographers with basic knowledge in geographic information system/science are this package's target audience. This package automates parallelization in spatial operations based on sf and terra functions for geospatial exposure assessment and environmental health research.

: To the best of our knowledge, no packaged solution exists for parallelization of geospatial operation. A teaching material briefly covers parallelization without packaging (RPubs source). sprawl (GitHub-only; not maintained) partially overlaps this package's functionality in that it includes convenience functions where a chain of elementary geospatial functions is wrapped.

: Not applicable.

: We used a literate programming package litr, which left artifacts in DESCRIPTION and R source code files. Would it be okay to include artifacts in these files? All of these except for DESCRIPTION entries are comments.

Thank you very much for consideration!

ldecicco-USGS commented 4 months ago

Thank you for your presubmission @sigmafelix ! Yes, this package makes sense as a geospatial submission . We welcome a full submission.

My only initial feedback is that I think you underestimate your list of users. I'm sure there are many other fields that would like to have easy ways to initiate parallel geospatial operations.

sigmafelix commented 4 months ago

Thank you for the comments @ldecicco-USGS! I will make a full submission soon.