EDIutils #498
Description
Date accepted: 2022-03-29
Reviewers:
Submitting Author Name: Colin Smith
Submitting Author Github Handle: @clnsmth
Repository: https://github.com/EDIorg/EDIutils
Version submitted:
Submission type: Standard
Editor: @adamhsparks
Reviewers: @bozaah, @laijasmine
Due date for @laijasmine: 2022-02-25
Archive: TBD
Version accepted: TBD
Language: en
Package: EDIutils
Title: An API Client for the Environmental Data Initiative Repository
Version: 0.0.0.9000
Authors@R:
c(person("Colin", "Smith", email = "colin.smith@wisc.edu", role = c("aut", "cre"), comment = "https://orcid.org/0000-0003-2261-9931"),
person("Corinna", "Gries", role = "ctb", comment = "0000-0002-9091-6543"))
Description: A client for the Environmental Data Initiative repository REST API. The EDI data repository <https://portal.edirepository.org/nis/home.jsp> is for publication and reuse of ecological data with emphasis on metadata accuracy and completeness. It is built upon the PASTA+ software stack <https://pastaplus-core.readthedocs.io/en/latest/index.html#> and was developed in collaboration with the US LTER Network <https://lternet.edu/>. EDIutils includes functions to search and access existing data, evaluate and upload new data, and assist other data management tasks common to repository users.
Imports:
curl,
httr,
xml2
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
Suggests:
knitr,
readr,
rmarkdown,
roxygen2,
testthat
URL: https://github.com/EDIorg/EDIutils, https://ediorg.github.io/EDIutils/
BugReports: https://github.com/EDIorg/EDIutils/issues
VignetteBuilder: knitr
Language: en-US
Scope
- [x ] data retrieval
- [ ] data extraction
- [ ] data munging
- [ x] data deposition
- [ ] workflow automation
- [ ] version control
- [ ] citation management and bibliometrics
- [ ] scientific software wrappers
- [ ] field and lab reproducibility tools
- [ ] database software bindings
- [ ] geospatial data
- [ ] text analysis
- Explain how and why the package falls under these categories (briefly, 1-2 sentences):
The package is an API client for the Environmental Data Initiative data repository, which serves the ecological and environmental science and monitoring domains.
- Who is the target audience and what are scientific applications of this package?
The target audiences are:
1.) Data authors who publish to the repository.
2.) Data users who retrieve data from the repository.
- Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?
There is no overlap.
- (If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?
Yes
-
If you made a pre-submission inquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.
-
Explain reasons for any
pkgcheckitems which your package is unable to pass.
All checks pass
Technical checks
Confirm each of the following by checking the box.
- [x ] I have read the guide for authors and rOpenSci packaging guide.
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, created with roxygen2.
- [ x] contains a vignette with examples of its essential functions and uses.
- [ x] has a test suite.
- [ x] has continuous integration, including reporting of test coverage using services such as Travis CI, Coveralls and/or CodeCov.
Publication options
-
[ x] Do you intend for this package to go on CRAN?
-
Do you intend for this package to go on Bioconductor?
-
Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:
MEE Options
- 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 guarantee that your manuscript will 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)
Code of conduct
- [ x] I agree to abide by rOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.