Description
Date accepted: 2022-03-08
Submitting Author Name: Mario Gavidia-Calderón
Submitting Author Github Handle: @quishqa
Other Package Authors Github handles: @Schuch666, @mftandra
Repository: https://github.com/quishqa/qualR
Version submitted:0.9.5
Submission type: Standard
Editor: @ldecicco-USGS
Reviewers: @beatrizmilz, @kauedesousa
Due date for @kauedesousa: 2021-12-02
Archive: TBD
Version accepted: TBD
- Paste the full DESCRIPTION file inside a code block below:
Package: qualR
Title: An R package to download Sao Paulo and Rio de Janeiro air pollution data
Version: 0.9.5
Authors@R: c(
person(given = "Mario",
family = "Gavidia-Calderón",
role = c("aut", "cre"),
email = "mario.calderon@iag.usp.br",
comment = c(ORCID = "0000-0002-7371-1116")),
person(given = "Maria de Fatima",
family = "Andrade",
role = c("ctb", "ths"),
email = "maria.andrade@iag.usp.br",
comment = c(ORCID = "0000-0001-5351-8311")),
person(given = "Daniel",
family = "Schuch",
role = c("aut","ctb"),
email = "d.schuch@northeastern.edu",
comment = c(ORCID = "0000-0001-5977-4519")))
Description: A package to download information from CETESB QUALAR and
MonitorAr systems. It contains function to download different parameters, a set of
criteria pollutants and the most frequent meteorological parameters used in
air quality data analysis and air quality model evaluation.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.1
Imports:
XML,
httr,
jsonlite
URL: https://github.com/quishqa/qualR
BugReports: https://github.com/quishqa/qualR/issues
Suggests:
covr,
testthat (>= 3.0.0)
Depends:
R (>= 3.5.0)
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
- 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):
Sao Paulo data is available through CETESB QUALAR System which limits the download to one parameter for one air quality station for one year, Rio de Janeiro is available through data.rio.API which is not so user-friendly.qualRdownloads multiple parameters for different air quality stations and produces completed ready-to-use data frames (missing hours are padded out with NA) with a date column in POSIXct type that allows temporal aggregation and compatibility withopenairpackage. -
Who is the target audience and what are scientific applications of this package?
Any researchers that work with air quality and weather data of Sao Paulo and Rio de Janeiro: Meteorologists, Epidemiologists, Environmental engineers, postgraduates students that work in air quality modeling and field measurements campaigns, also stakeholders and the community. This packages facilitates the retrival of Sao Paulo and Rio de Janeiro air quality data, facilitates exploratory data analysis, and enhance code reproducibility. -
Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?
koffingretrieves Sao Paulo State air quality data.qualRoffers more functionalities (i.e. allows retrieve many parameters from one air quality station, accepts pollutants abbreviations and air quality station names in functions parameters, etc), and returns complete datasets ready to use (no missing hours, concentration in numeric format).qualRalso include Rio de Janeiro city and the location of each air quality stations.qualRis more user friendly and it is actively maintainded. -
(If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?
-
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.
Technical checks
Confirm each of the following by checking the box.
- I have read the guide for authors and rOpenSci packaging guide.
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 using services such as Travis CI, Coveralls and/or CodeCov.
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.