R package sundialr

[sn248]

Summary

• What does this package do? (explain in 50 words or less): This package provides an interface to the solvers in SUNDIALS C library (https://computation.llnl.gov/projects/sundials). Currently, the package provides an interface to serial version of 'cvode' in R

• Paste the full DESCRIPTION file inside a code block below:

Package: sundialr
Type: Package
Title: An Interface to 'SUNDIALS' Ordinary Differential Equation (ODE) Solvers 
Version: 0.1.1
Authors@R: c(
    person("Satyaprakash", "Nayak", "", "sn248@cornell.edu", c("aut", "cre")),
    person("Scott D", "Cohen", "", "", c("ctb")),
    person("Alan C", "Hindmarsh", "", "", c("ctb")),
    person("Radu", "Serban", "", "", c("ctb")),
    person("Dan", "Shumaker", "", "", c("ctb")),
    person("Daniel R", "Reynolds", "", "", c("ctb")),
    person("Aaron", "Collier", "", "", c("ctb")),
    person("David", "Gardner", "", "", c("ctb")),
    person("Carol", "Woodward", "", "", c("ctb")),
    person("Slaven", "Peles", "", "", c("ctb")),
    person("Peter", "Brown", "", "", c("ctb")),
    person("Hilari C", "Tiedeman", "", "", c("ctb")),
    person("Ting", "Yan", "", "", c("ctb")),
    person("Lawrence Livermore National Security", role =  c("cph")),
    person("Southern Methodist University", role =  c("cph"))
    )
Maintainer: Satyaprakash Nayak <sn248@cornell.edu>
URL: https://github.com/sn248/sundialr
BugReports: https://github.com/sn248/sundialr/issues
Description: Provides a way to call the functions in 'SUNDIALS' C ODE solving library (<https://computation.llnl.gov/projects/sundials>). Currently the serial version of ODE solver, 'CVODE' from the library can be accessed. The package requires ODE to be written as an 'R' or 'Rcpp' function and does not require the 'SUNDIALS' library to be installed on the local machine.
License: GPL (>=2)
LazyData: TRUE
Imports:
    Rcpp (>= 0.12.5)
LinkingTo:
    Rcpp
RoxygenNote: 6.0.1
Suggests: knitr,
    rmarkdown
VignetteBuilder: knitr

• URL for the package (the development repository, not a stylized html page): https://github.com/sn248/sundialr
• Please indicate which category or categories from our package fit policies this package falls under *and why(? (e.g., data retrieval, reproducibility. If you are unsure, we suggest you make a pre-submission inquiry.): I think the package falls under text analysis category (This does not include packages with new methods, but only implementation or wrapping of previously published methods).

This is because, this package provides a wrapper for C library in R in the hope of providing robust, industry-standard ODE/PDE solving capability in R.

•   Who is the target audience and what are scientific applications of this package?   Anyone who is interested in solving initial value problems (Ordinary Differential Equations) in R.

• Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category? Yes, package deSolve and odeintr provide ODE solving capability. I am using a modern version of a renowned C library in R. In future, I hope to provide an interface to the wide ranging capabilities of SUNDIALS (e.g., parallel computing, CUDA etc.) in R

•   If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.

Requirements

Confirm each of the following by checking the box. This package:

• [X] does not violate the Terms of Service of any service it interacts with.
• [X] has a CRAN and OSI accepted license.
• [X] contains a README with instructions for installing the development version.
• [X] includes documentation with examples for all functions.
• [X] contains a vignette with examples of its essential functions and uses.
• [ ] has a test suite.
• [X] has continuous integration, including reporting of test coverage, using services such as Travis CI, Coveralls and/or CodeCov.
• [X] I agree to abide by ROpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.

Publication options

• [X] Do you intend for this package to go on CRAN?
• [] Do you wish to automatically submit to the Journal of Open Source Software? If so:
  • [ ] The package has an obvious research application according to JOSS's definition.
  • [ ] The package contains a paper.md matching JOSS's requirements with a high-level description in the package root or in inst/.
  • [ ] The package is deposited in a long-term repository with the DOI:
  • (Do not submit your package separately to JOSS)
• [ ] Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:
  • [ ] The package is novel and will be of interest to the broad readership of the journal.
  • [ ] The manuscript describing the package is no longer than 3000 words.
  • [ ] You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see MEE's Policy on Publishing Code)
  • (Scope: Do consider MEE's Aims and Scope for your manuscript. We make no gaurantee that your manuscript willl be within MEE scope.)
  • (Although not required, we strongly recommend having a full manuscript prepared when you submit here.)
  • (Please do not submit your package separately to Methods in Ecology and Evolution)

Detail

• [X] Does R CMD check (or devtools::check()) succeed? Paste and describe any errors or warnings:

• [X] Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:

• If this is a resubmission following rejection, please explain the change in circumstances:

• If possible, please provide recommendations of reviewers - those with experience with similar packages and/or likely users of your package - and their GitHub user names:

[maelle]

Thanks a lot for your submission @sn248! However, the package isn't specific for text analysis, hence as a wrapper to an existing C library for solvers, it is out-of-scope for onboarding.

You might try submitting it to JOSS.