-
-
Notifications
You must be signed in to change notification settings - Fork 106
Description
Summary
-
What does this package do? (explain in 50 words or less):
Downloads supplementary materials from published papers using their DOIs as a reference. This facilitates reproducible analyses. -
Paste the full DESCRIPTION file inside a code block below:
Package: suppdata
Type: Package
Title: Downloading Supplementary Data from Published Manuscripts
Version: 0.9-0
Date: 2018-02-02
Author: William D. Pearse, Scott Chamberlain
Maintainer: William D. Pearse <will.pearse@gmail.com>
Description: Downloads data supplementary materials from manuscripts,
using papers' DOIs as references. Includes some code to download
from other Internet APIs (e.g., Xeno-Canto, EPMC).
License: MIT + file LICENSE
URL: https://github.com/ropensci/fulltext
BugReports: https://github.com/ropensci/fulltext/issues
VignetteBuilder: knitr
LazyLoad: yes
Suggests:
knitr (>= 1.6),
testthat (>= 2.0.0),
fulltext(>= 0.1.4.9000)
Imports:
httr (>= 1.0.0),
xml2 (>= 1.2.0),
jsonlite (>= 1.5),
RCurl (>= 1.95-4.10),
rcrossref (>= 0.8.0)
RoxygenNote: 6.0.1
-
URL for the package: https://github.com/willpearse/suppdata
-
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.):
- data retrieval: because it downloads data from online scientific publications.
- reproducibility: because by downloading raw data, it facilitates reproducible analysis scripts
-
Who is the target audience and what are scientific applications of this package?
- Audience: anyone (re-)analysing published scientific data
- Application: Conducting reproducible analyses, database creation scripts
-
Are there other R packages that accomplish the same thing? If so, how does
yours differ or meet our criteria for best-in-category?
Originally, this code was part of fulltext
, but has now been split out. That is the only package I'm aware of that does this.
- 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.
@sckott
Requirements
Confirm each of the following by checking the box. This package:
- does not violate the Terms of Service of any service it interacts with.
- This package does download data from journal publishers such as Wiley. I have heard stories/rumours of them getting very unhappy about people downloading articles from their websites at high speed. I'm not aware that this package violates their terms/conditions, but I want to flag this here. This code has already been part of an ROpenSci package (
fulltext
) without any problems, so I can't see that this is an issue.
- This package does download data from journal publishers such as Wiley. I have heard stories/rumours of them getting very unhappy about people downloading articles from their websites at high speed. I'm not aware that this package violates their terms/conditions, but I want to flag this here. This code has already been part of an ROpenSci package (
- has a CRAN and OSI accepted license.
- contains a README with instructions for installing the development version.
- includes documentation with examples for all functions.
- contains a vignette with examples of its essential functions and uses.
- has a test suite.
- has continuous integration, including reporting of test coverage, using services such as Travis CI, Coveralls and/or CodeCov.
- 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
- 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 ininst/
. - The package is deposited in a long-term repository with the DOI: 0.5281/zenodo.1168713
- 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.
- (Please do not submit your package separately to Methods in Ecology and Evolution)
Detail
-
Does
R CMD check
(ordevtools::check()
) succeed? Paste and describe any errors or warnings: -
Does the package conform to rOpenSci packaging guidelines? Please describe any exceptions:
Yes it does, and all this code was, previously, part of the ROpenSci packagefulltext
. -
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: