comtradr: API wrapper for UN Comtrade data #613
Description
Date accepted: 2024-01-09
Submitting Author Name: Paul Bochtler
Submitting Author Github Handle: @datapumpernickel
Repository: https://github.com/ropensci/comtradr
Version submitted: 0.4.0 (not yet released)
Submission type: Standard
Editor: @noamross
Reviewers: @ernestguevarra, @potterzot
Archive: TBD
Version accepted: TBD
Language: en
- Paste the full DESCRIPTION file inside a code block below:
Package: comtradr
Title: Interface with the United Nations Comtrade API
Version: 0.4.0.0
Authors@R: c(
person("Paul", "Bochtler",
email = "[email protected]",
role = c("aut", "cre","cph"),
comment = c(ORCID = "0000-0002-9146-6185")),
person("Harriet", "Goers",
email = "[email protected]",
role = c("aut")),
person("Chris", "Muir",
email = "[email protected]",
role = c("aut")),
person("Alicia", "Schep",
role = "rev",
comment = c(ORCID = "0000-0002-3915-0618",
"Alicia reviewed the package for rOpenSci,
see https://github.com/ropensci/onboarding/issues/141")),
person("Rafael", "Hellwig",
role = "rev",
comment = c(ORCID = "0000-0002-3092-3493",
"Rafael reviewed the package for rOpenSci,
see https://github.com/ropensci/onboarding/issues/141")),
person("Juergen", "Amann", role=c("ctb")))
Description: Interface with and extract data from the United Nations Comtrade
API <https://comtradeplus.un.org/>. Comtrade provides country level shipping
data for a variety of commodities, these functions allow for easy API query
and data returned as a tidy data frame.
Depends: R (>= 4.1.0)
License: GPL-3
Encoding: UTF-8
LazyData: true
Imports:
lifecycle,
fs,
readr,
askpass,
cli,
httr2,
rlang,
stringr,
poorman,
lubridate,
purrr
RoxygenNote: 7.2.3
URL: https://docs.ropensci.org/comtradr/, https://github.com/ropensci/comtradr
BugReports: https://github.com/ropensci/comtradr/issues
NeedsCompilation: no
Maintainer: Paul Bochtler <[email protected]>
Suggests:
covr,
dplyr,
ggplot2,
httptest2,
knitr,
rmarkdown,
testthat (>= 3.0.0),
vcr
VignetteBuilder: knitr
Roxygen: list(markdown = TRUE)
Config/testthat/edition: 3
Scope
-
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.):
- data retrieval
- data extraction
- data munging
- data deposition
- data validation and testing
- 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 leverages httr2 to extract trade data from the UN Comtrade API, which is one of the standard sources for trade data world wide. See here for more info on the API. -
Who is the target audience and what are scientific applications of this package?
The package can be used for econometric research into the trade relations of countries, dependencies between countries and many other use cases for trade data. The target audience are students and scientists, as well as practitioneers in the field of econometrics, political science among others. -
Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?
As far as I am aware, there is no other package that wraps the UN Comtrade API.
-
(If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?
Not applicable. -
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.
The package has previouslz been reviewed by rOpenSci and is already part of the rOpenSci suite. However, since the API underwent fundamental changes, so did most of the functions of the package. Hence, we asked, whether we could get another review. This inquiry was answered positively here: ropensci/software-review-meta#100
- Explain reasons for any
pkgcheckitems which your package is unable to pass.
As far as I am aware, the package currently passes all the pkgcheck checks.
Technical checks
Confirm each of the following by checking the box.
- I have read the rOpenSci packaging guide.
- I have read the author guide and I expect to maintain this package for at least 2 years or to find a replacement.
This package:
- does not violate the Terms of Service of any service it interacts with.
- has a CRAN and OSI accepted license.
- contains a README with instructions for installing the development version.
- includes documentation with examples for all functions, created with roxygen2.
- contains a vignette with examples of its essential functions and uses.
- has a test suite.
- has continuous integration, including reporting of test coverage.
Publication options
-
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
- I agree to abide by rOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.