Submitting Author Name: Simon Parker
Submitting Author Github Handle: @simpar1471
Repository: https://www.github.com/simpar1471/openFDA
Version submitted: 0.1.0.9000
Submission type: Standard
Editor: @maelle
Reviewers: @tanho63, @nrennie
Archive: TBD
Version accepted: TBD
Language: en
Package: openFDA
Title: 'openFDA' API
Version: 0.1.0.9000
Authors@R:
person("Simon", "Parker", , "simon.parker.24@ucl.ac.uk",
role = c("aut", "cre", "cph"),
comment = c(ORCID = "0009-0003-8214-4496"))
Description: The 'openFDA' API facilitates access to U.S. Food and Drug
Administration (FDA) data on drugs, devices, foodstuffs, tobacco, and more.
This package makes the API easily accessible with 'httr2', returning
objects which the user can convert to JSON data and parse. Kass-Hout TA, Xu
Z, Mohebbi M et al. (2016) <doi:10.1093/jamia/ocv153>.
License: GPL (>= 3)
URL: https://github.com/simpar1471/openFDA,
https://simpar1471.github.io/openFDA/
BugReports: https://github.com/simpar1471/openFDA/issues
Depends:
R (>= 4.1.0)
Imports:
cli,
httr2,
checkmate,
purrr,
rlang,
vctrs
Config/Needs/website: rmarkdown
Suggests:
knitr,
rmarkdown,
testthat (>= 3.0.0),
stringr
Config/testthat/edition: 3
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.2
VignetteBuilder: knitr
Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):
Explain how and why the package falls under these categories (briefly, 1-2 sentences):
openFDA retrieves data from the elastic-search based openFDA API, using httr2. The package can be used to query the API on different fields, and successful queries return httr2 response objects with JSON data that R users can manipulate further.
The package is intended for anyone wanting to use the openFDA API through R. These include researchers focused on pharmacovigilance (e.g. with the device adverse event endpoints) or veterinary researchers (e.g. with the animal product adverse event endpoints) - really, any user interested in accessing FDA data.
There are other packages. These include the rOpenHealth/openfda package, in which queries are built up in an httr2-like manner. It automatically converts the response data to data frames, but this package returns the underlying httr2 response object, which users can then choose how to parse themselves. Their package does not have a CI suite, nor a documentation website. There is also ck2136/FDAopenR, which has a test suite with 100% coverage and a now-defunct link to Travis CI. It takes an object-oriented approach which I haven't quite wrapped my head around from looking at the README.
Personally, I prefer 'one function, more parameters' approach in my package - but to each their own. I also believe that this package has a wider and more useful array of error handlers, which point the user to commonly encountered problems with the openFDA API itself. This package is also cleared by the relatively more stringent pkgcheck() checks.
This package is also already on CRAN. I know the guide for authors specifies you'd rather not have it this way round, but I didn't intend to submit the package for review when I first made it.
Not applicable
@tag the editor you contacted.Not applicable
pkgcheck items which your package is unable to pass.Everything passes on CI. My functions get_api_key() and set_api_key() are not unique to this package, but I think the names are appropriate to the actions these functions perform.
Confirm each of the following by checking the box.
This package:
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:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4