Skip to content

request for R package RAQSAPI submission #744

Description

@mccroweyclinton-EPA

Submitting Author Name: Clinton Mccrowey
Submitting Author Github Handle: @mccroweyclinton-EPA
Repository: https://github.com/USEPA/RAQSAPI
Version submitted: v2.0.5
Submission type: Standard
Editor: @ldecicco-USGS
Reviewers: @milanmlft, @rkrug

Archive: TBD
Version accepted: TBD
Language: en


  • Paste the full DESCRIPTION file inside a code block below:
Type: Package
Package: RAQSAPI
Version: 2.0.6
Title: A Simple Interface to the US EPA Air Quality System Data Mart API
Description: Retrieve air monitoring data and associated metadata from the US
  Environmental Protection Agency's Air Quality System service using functions.
  See <https://aqs.epa.gov/aqsweb/documents/data_api.html> for details about
  the US EPA Data Mart API <doi: 10.32614/CRAN.package.RAQSAPI>.
Encoding: UTF-8
Authors@R: c(person(given="Clinton", family="Mccrowey",
                    email="mccrowey.clinton@epa.gov",
                    role=c("cre", "aut"),
                    comment="United States Environmental Protection
                             Agency Region 3 Air and Radiation Division"),
             person(given="Timothy", family="Sharac", role=c("ctb","rev"),
                    email=NULL,
                    comment="United States Environmental Protection Agency"),
             person(given = "Nick", family = "Mangus", email = NULL,
                    role=c("rev"),
                    comment="United States Environmental Protection Agency"),
             person(given = "Doug", family = "Jager",
                    email=NULL, role=c("ctb", "rev"),
                    comment="United States Environmental Protection Agency"),
             person(given = "Ryan",family = "Brown",
                    email=NULL, role=c("ctb", "rev"),
                    comment="United States Environmental Protection Agency"),
             person(given = "Daniel", family = "Garver",
                    email=NULL, role=c("ctb", "rev"),
                    comment="United States Environmental Protection Agency"),
             person(given = "Benjamin", family = "Wells",
                    email=NULL, role=c("ctb", "rev"),
                    comment="United States Environmental Protection Agency"),
             person(given = "Hayley", family= "Brittingham",
                    email = NULL, role=c("rev", "ctr"),
                    comment="Neptune and Company"),
             person(given = "Jeffrey", family = "Hollister",
                    email = "hollister.jeff@epa.gov", role = c("rev"),
                    comment = c("United States Environmental Protection Agency",
                                ORCID = "0000-0002-9254-9740"
                                )
                    ),
            person(given = "Edward", family = "Andrews",
                   email = "edward.s.andrews@wv.gov",
                   role = c("rev", "ctb"),
                   comment = "West Virginia Department of Environmental Protection, Division of Air Quality"
                  ),
            person(given= "Cynthia", family = "Stahl",
                   email = "stahl.cynthia@epa.gov",
                   role="rev",
                   comment=("United States Environmental Protection
                            Agency Region 3 Air and Radiation Division")
                  ),
            person(given= "Maria", family="Morresi",
                   email="Morresi.Maria@epa.gov",
                   role=c("ctr", "rev"),
                   comment="ASRC Federal"
                   )
            )
URL: https://github.com/USEPA/RAQSAPI/,
     https://aqs.epa.gov/aqsweb/documents/data_api.html
BugReports: https://github.com/USEPA/RAQSAPI/issues
Depends: R (>= 4.0.0)
Imports: dplyr,
    glue,
    gtools,
    httr2,
    lifecycle,
    lubridate,
    methods,
    magrittr,
    purrr,
    rlang,
    stringr,
    tibble,
    tidyselect
Suggests: cli,
    covr,
    devtools,
    goodpractice,
    httptest2,
    keyring,
    knitr,
    rmarkdown,
    remotes,
    roxygen2,
    spelling,
    testthat (>= 3.0.0),
    usethis,
    withr
SystemRequirements: package manual and Vignettes require pandoc
                    (>= 1.14) http://pandoc.org)
RoxygenNote: 7.3.3
VignetteBuilder: knitr
BuildVignettes: true
ByteCompile: true
License: MIT + file LICENSE
License_is_FOSS: yes
NeedsCompilation: no
License_restricts_use: no
Language: en-US
Collate:
    'AQS_DATAMART_APIv2-S3-class.R'
    'AQSAPI_helperfunctions.R'
    'bysite.R'
    'bycounty.R'
    'bystate.R'
    'byma.R'
    'bypqao.R'
    'bycbsa.R'
    'bybox.R'
    'RAQSAPIlistfunctions.R'
    'setupfunctions.R'
    'zzz.R'
    'RAQSAPI-package.R'
    'deprecated.R'
Copyright: United States Environmental Protection Agency
RdMacros: lifecycle
Roxygen: list(markdown = TRUE)
Config/testthat/edition: 3
X-schema.org-keywords: United State Environmental Protection Agency,
                       Environmental-data-retrieval, Air-Quality-System,
                       AQS-DataMart, Air-monitoring, Environmental-monitoring
Config/testthat/load-all: list(export_all = FALSE, helpers = FALSE)

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
    • translation
  • Explain how and why the package falls under these categories (briefly, 1-2 sentences):

RAQSAPI is a R package that was designed specifically as a simple interface to the US Environmental Protection Agency Air Quality System Data Mart API which is a data store of ambient air pollution data collected by EPA, state, local, and tribal air pollution control agencies from over thousands of monitors. AQS also contains meteorological data, descriptive information about each monitoring station (including its geographic location and its operator), and data quality assurance/quality control information.

  • Who is the target audience and what are scientific applications of this package?

Environmental scientists, data scientist, Federal, State, Local, Tribal Air monitoring agencies. Community groups. Citizens concerned about the quality of air in the US.

aqsr, RAQSAPI is still under active development and will be updated reflecting future changes to the AQS Data MART API. RAQSAPI is developed by EPA staff. RAQSAPI allows for multi year data pulls. Also RAQSAPI is the only package that I am aware of that is available from CRAN.

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.

#712

  • Explain reasons for any pkgcheck items which your package is unable to pass.

Technical checks

Currently I have pkgcheck to only check for issues in the main branch most of these issues are old, some have been resolved in other branches.

✖️ Package coverage failed
✖️ R CMD check found 1 error

I believe both of these issues are related to issues that I am currently having with implementing mock test with R package:httptest2. Several members of the Ropensci team is currently helping me to work out these issues.

✖️ does not have a 'contributing' file.
currently pkgcheck only checks for issues in the main branch. the branch "test_httptest2" contains the current version of the contributing.md file and will be merged into main in the future. If required now I can commit it to main.

Confirm each of the following by checking the box.

This package:

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions