diff --git a/.Rbuildignore b/.Rbuildignore index d64f003..0af9392 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -14,7 +14,6 @@ ^README.md ^README.html ^RAQSAPI.Rproj -^doc$ ^dev$ .out$ .log$ @@ -40,12 +39,10 @@ dev/* ^.*\.Rproj$ ^\.Rproj\.user$ codemeta.json -^revdep$ ^LICENSE\.md$ - # Output files from R CMD check /*.Rcheck/ - # RAQSAPI package files ^.tar.gz ^.zip +^CITATION\.cff$ diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..c0844b6 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,478 @@ +# ----------------------------------------------------------- +# CITATION file created with {cffr} R package, v0.5.0 +# See also: https://docs.ropensci.org/cffr/ +# ----------------------------------------------------------- + +cff-version: 1.2.0 +message: 'To cite package "RAQSAPI" in publications use:' +type: software +license: MIT +title: 'RAQSAPI: A Simple Interface to the US EPA Air Quality System Data Mart API' +version: 2.0.5 +abstract: Retrieve air monitoring data and associated metadata from the US Environmental + Protection Agency's Air Quality System service using functions. See + for details about the US EPA Data Mart API. +authors: +- family-names: Mccrowey + given-names: Clinton + email: mccrowey.clinton@epa.gov +- family-names: Sharac + given-names: Timothy +- family-names: Mangus + given-names: Nick +- family-names: Jager + given-names: Doug +- family-names: Brown + given-names: Ryan +- family-names: Garver + given-names: Daniel +- family-names: Wells + given-names: Benjamin +- family-names: Brittingham + given-names: Hayley +- family-names: Hollister + given-names: Jeffrey + email: hollister.jeff@epa.gov + orcid: https://orcid.org/0000-0002-9254-9740 +- family-names: Andrews + given-names: Edward + email: edward.s.andrews@wv.gov +preferred-citation: + type: manual + title: A R Interface to the US EPA Air Quality System Data Mart API + authors: + - family-names: Mccrowey + given-names: Clinton + email: mccrowey.clinton@epa.gov + - family-names: Sharac + given-names: Timothy + - family-names: Mangus + given-names: Nick + - family-names: Jager + given-names: Doug + - family-names: Brown + given-names: Ryan + - family-names: Garver + given-names: Daniel + - family-names: Wells + given-names: Benjamin + - family-names: Brittingham + given-names: Hayley + year: '2023' + url: https://cran.r-project.org/package=RAQSAPI +repository: https://CRAN.R-project.org/package=RAQSAPI +repository-code: https://github.com/USEPA/RAQSAPI +url: https://github.com/USEPA/RAQSAPI +contact: +- family-names: Mccrowey + given-names: Clinton + email: mccrowey.clinton@epa.gov +keywords: +- United State Environmental Protection Agency +- Environmental-data-retrieval +- Air-Quality-System +- AQS-Datamart +- Air-monitoring +- Environmental-monitoring +- airmonitoring +- aqs +- datamart +- environmental-data-retrieval +- environmental-monitoring +- r03 +- rpackage +- rprogramming +- usepa +references: +- type: software + title: 'R: A Language and Environment for Statistical Computing' + notes: Depends + url: https://www.R-project.org/ + authors: + - name: R Core Team + location: + name: Vienna, Austria + year: '2023' + institution: + name: R Foundation for Statistical Computing + version: '>= 4.0.0' +- type: software + title: dplyr + abstract: 'dplyr: A Grammar of Data Manipulation' + notes: Imports + url: https://dplyr.tidyverse.org + repository: https://CRAN.R-project.org/package=dplyr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: François + given-names: Romain + orcid: https://orcid.org/0000-0002-2444-4226 + - family-names: Henry + given-names: Lionel + - family-names: Müller + given-names: Kirill + orcid: https://orcid.org/0000-0002-1416-3412 + - family-names: Vaughan + given-names: Davis + email: davis@posit.co + orcid: https://orcid.org/0000-0003-4777-038X + year: '2023' +- type: software + title: glue + abstract: 'glue: Interpreted String Literals' + notes: Imports + url: https://glue.tidyverse.org/ + repository: https://CRAN.R-project.org/package=glue + authors: + - family-names: Hester + given-names: Jim + orcid: https://orcid.org/0000-0002-2739-7082 + - family-names: Bryan + given-names: Jennifer + email: jenny@rstudio.com + orcid: https://orcid.org/0000-0002-6983-2759 + year: '2023' +- type: software + title: httr2 + abstract: 'httr2: Perform HTTP Requests and Process the Responses' + notes: Imports + url: https://httr2.r-lib.org + repository: https://CRAN.R-project.org/package=httr2 + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + year: '2023' +- type: software + title: lifecycle + abstract: 'lifecycle: Manage the Life Cycle of your Package Functions' + notes: Imports + url: https://lifecycle.r-lib.org/ + repository: https://CRAN.R-project.org/package=lifecycle + authors: + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + orcid: https://orcid.org/0000-0003-4757-117X + year: '2023' +- type: software + title: lubridate + abstract: 'lubridate: Make Dealing with Dates a Little Easier' + notes: Imports + url: https://lubridate.tidyverse.org + repository: https://CRAN.R-project.org/package=lubridate + authors: + - family-names: Spinu + given-names: Vitalie + email: spinuvit@gmail.com + - family-names: Grolemund + given-names: Garrett + - family-names: Wickham + given-names: Hadley + year: '2023' +- type: software + title: magrittr + abstract: 'magrittr: A Forward-Pipe Operator for R' + notes: Imports + url: https://magrittr.tidyverse.org + repository: https://CRAN.R-project.org/package=magrittr + authors: + - family-names: Bache + given-names: Stefan Milton + email: stefan@stefanbache.dk + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + year: '2023' +- type: software + title: purrr + abstract: 'purrr: Functional Programming Tools' + notes: Imports + url: https://purrr.tidyverse.org/ + repository: https://CRAN.R-project.org/package=purrr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: Henry + given-names: Lionel + email: lionel@rstudio.com + year: '2023' +- type: software + title: rlang + abstract: 'rlang: Functions for Base Types and Core R and ''Tidyverse'' Features' + notes: Imports + url: https://rlang.r-lib.org + repository: https://CRAN.R-project.org/package=rlang + authors: + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2023' +- type: software + title: stringr + abstract: 'stringr: Simple, Consistent Wrappers for Common String Operations' + notes: Imports + url: https://stringr.tidyverse.org + repository: https://CRAN.R-project.org/package=stringr + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2023' +- type: software + title: tibble + abstract: 'tibble: Simple Data Frames' + notes: Imports + url: https://tibble.tidyverse.org/ + repository: https://CRAN.R-project.org/package=tibble + authors: + - family-names: Müller + given-names: Kirill + email: kirill@cynkra.com + orcid: https://orcid.org/0000-0002-1416-3412 + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + year: '2023' +- type: software + title: covr + abstract: 'covr: Test Coverage for Packages' + notes: Suggests + url: https://covr.r-lib.org + repository: https://CRAN.R-project.org/package=covr + authors: + - family-names: Hester + given-names: Jim + email: james.f.hester@gmail.com + year: '2023' +- type: software + title: devtools + abstract: 'devtools: Tools to Make Developing R Packages Easier' + notes: Suggests + url: https://devtools.r-lib.org/ + repository: https://CRAN.R-project.org/package=devtools + authors: + - family-names: Wickham + given-names: Hadley + - family-names: Hester + given-names: Jim + - family-names: Chang + given-names: Winston + - family-names: Bryan + given-names: Jennifer + email: jenny@rstudio.com + orcid: https://orcid.org/0000-0002-6983-2759 + year: '2023' +- type: software + title: goodpractice + abstract: 'goodpractice: Advice on R Package Building' + notes: Suggests + url: https://github.com/mangothecat/goodpractice + repository: https://CRAN.R-project.org/package=goodpractice + authors: + - family-names: Marks + given-names: Karina + email: karina.marks@ascent.io + - family-names: de Bortoli + given-names: Daniel + - family-names: Csardi + given-names: Gabor + email: csardi.gabor@gmail.com + - family-names: Frick + given-names: Hannah + email: hannah.frick@gmail.com + - family-names: Jones + given-names: Owen + email: owenjonesuob@gmail.com + - family-names: Alexander + given-names: Hannah + email: halexander@mango-solutions.com + year: '2023' +- type: software + title: keyring + abstract: 'keyring: Access the System Credential Store from R' + notes: Suggests + url: https://keyring.r-lib.org/ + repository: https://CRAN.R-project.org/package=keyring + authors: + - family-names: Csárdi + given-names: Gábor + email: csardi.gabor@gmail.com + year: '2023' +- type: software + title: knitr + abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R' + notes: Suggests + url: https://yihui.org/knitr/ + repository: https://CRAN.R-project.org/package=knitr + authors: + - family-names: Xie + given-names: Yihui + email: xie@yihui.name + orcid: https://orcid.org/0000-0003-0645-5666 + year: '2023' +- type: software + title: markdown + abstract: 'markdown: Render Markdown with ''commonmark''' + notes: Suggests + url: https://github.com/rstudio/markdown + repository: https://CRAN.R-project.org/package=markdown + authors: + - family-names: Xie + given-names: Yihui + email: xie@yihui.name + orcid: https://orcid.org/0000-0003-0645-5666 + - family-names: Allaire + given-names: JJ + - family-names: Horner + given-names: Jeffrey + year: '2023' +- type: software + title: rmarkdown + abstract: 'rmarkdown: Dynamic Documents for R' + notes: Suggests + url: https://pkgs.rstudio.com/rmarkdown/ + repository: https://CRAN.R-project.org/package=rmarkdown + authors: + - family-names: Allaire + given-names: JJ + email: jj@posit.co + - family-names: Xie + given-names: Yihui + email: xie@yihui.name + orcid: https://orcid.org/0000-0003-0645-5666 + - family-names: Dervieux + given-names: Christophe + email: cderv@posit.co + orcid: https://orcid.org/0000-0003-4474-2498 + - family-names: McPherson + given-names: Jonathan + email: jonathan@posit.co + - family-names: Luraschi + given-names: Javier + - family-names: Ushey + given-names: Kevin + email: kevin@posit.co + - family-names: Atkins + given-names: Aron + email: aron@posit.co + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + - family-names: Cheng + given-names: Joe + email: joe@posit.co + - family-names: Chang + given-names: Winston + email: winston@posit.co + - family-names: Iannone + given-names: Richard + email: rich@posit.co + orcid: https://orcid.org/0000-0003-3925-190X + year: '2023' +- type: software + title: roxygen2 + abstract: 'roxygen2: In-Line Documentation for R' + notes: Suggests + url: https://roxygen2.r-lib.org/ + repository: https://CRAN.R-project.org/package=roxygen2 + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: Danenberg + given-names: Peter + email: pcd@roxygen.org + - family-names: Csárdi + given-names: Gábor + email: csardi.gabor@gmail.com + - family-names: Eugster + given-names: Manuel + year: '2023' +- type: software + title: spelling + abstract: 'spelling: Tools for Spell Checking in R' + notes: Suggests + url: https://docs.ropensci.org/spelling/ + repository: https://CRAN.R-project.org/package=spelling + authors: + - family-names: Ooms + given-names: Jeroen + email: jeroen@berkeley.edu + orcid: https://orcid.org/0000-0002-4035-0289 + - family-names: Hester + given-names: Jim + email: james.hester@rstudio.com + year: '2023' +- type: software + title: testthat + abstract: 'testthat: Unit Testing for R' + notes: Suggests + url: https://testthat.r-lib.org + repository: https://CRAN.R-project.org/package=testthat + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + year: '2023' + version: '>= 3.0.0' +- type: software + title: usethis + abstract: 'usethis: Automate Package and Project Setup' + notes: Suggests + url: https://usethis.r-lib.org + repository: https://CRAN.R-project.org/package=usethis + authors: + - family-names: Wickham + given-names: Hadley + email: hadley@posit.co + orcid: https://orcid.org/0000-0003-4757-117X + - family-names: Bryan + given-names: Jennifer + email: jenny@posit.co + orcid: https://orcid.org/0000-0002-6983-2759 + - family-names: Barrett + given-names: Malcolm + email: malcolmbarrett@gmail.com + orcid: https://orcid.org/0000-0003-0299-5825 + - family-names: Teucher + given-names: Andy + email: andy.teucher@posit.co + orcid: https://orcid.org/0000-0002-7840-692X + year: '2023' +- type: software + title: withr + abstract: 'withr: Run Code ''With'' Temporarily Modified Global State' + notes: Suggests + url: https://withr.r-lib.org + repository: https://CRAN.R-project.org/package=withr + authors: + - family-names: Hester + given-names: Jim + - family-names: Henry + given-names: Lionel + email: lionel@posit.co + - family-names: Müller + given-names: Kirill + email: krlmlr+r@mailbox.org + - family-names: Ushey + given-names: Kevin + email: kevinushey@gmail.com + - family-names: Wickham + given-names: Hadley + email: hadley@rstudio.com + - family-names: Chang + given-names: Winston + year: '2023' diff --git a/MD5 b/MD5 index b3d84e3..23e2ba5 100644 --- a/MD5 +++ b/MD5 @@ -1,6 +1,7 @@ +2d3e0e574783202b33c52d6feba58dd3 *CITATION.cff d3a7f7cc6aca27a043309d5bf9f32edc *codemeta.json -41bc862202d75db51f4feb1f17fb2021 *cran-comments.md -41bc862202d75db51f4feb1f17fb2021 *cran-comments.Rmd +bfa24dfc7e0f2f217163fa917e8d2392 *cran-comments.md +bfa24dfc7e0f2f217163fa917e8d2392 *cran-comments.Rmd 7b3092d9d1ec246090f159fd55deeb57 *DESCRIPTION 1dc95961c4c280f8645a65d15662725f *dev/contributing.md 4fc13def6ec5d889261f1f22a13ba542 *dev/contributing.Rmd @@ -116,9 +117,9 @@ f41ed996be135fb35afe00641621da61 *man/figures/lifecycle-questioning.svg ed42e3fbd7cc30bc6ca8fa9b658e24a8 *man/figures/lifecycle-stable.svg bf2f1ad432ecccee3400afe533404113 *man/figures/lifecycle-superseded.svg 7ce4525010156c02adaf819a8c835134 *man/RAQSAPI.Rd -57d6cc4244ee282e5008f2245cbb451f *NAMESPACE +797940f405cb85557ee355e7eae5894d *NAMESPACE 904839971aff979c1716322c7d8bcdff *NEWS.md -b3ea59c2042dbff778d8bec40aede580 *R/AQSAPI_helperfunctions.R +b63d94a18d37de10925e09e6c3bb2eeb *R/AQSAPI_helperfunctions.R a3558975d0256839b174ab7868833075 *R/bybox.R bd8b36cc7325d4fc8b8ed894f0046678 *R/bycbsa.R 253ea551f88c65c1c49feff3cb33f552 *R/bycounty.R @@ -132,7 +133,7 @@ d82b1ff8ee144afca1879e5b8dc58840 *R/byma.R e6e3b87e48f4403642382987b0f40714 *R/setupfunctions.R 6e659bb3bbf313dc819d4c029f0b22d0 *R/zzz.R a69de5455537022556f014579766be59 *RAQSAPI.Rproj -f46d3c0ef441d77706bcf750b4aa45c8 *README.md +feb8f6defa51349e6110273bedcc046b *README.md b2370e0e3f63a29557cd8f74746d74f6 *README.Rmd 7ed08f3fb96a77ec01c95c2ad7964250 *revdep/data.sqlite 34952a5944548ea4fc132a9899f8e6ab *revdep/email.yml @@ -1328,11 +1329,11 @@ f7ea691da1baf266047ed7af4b0c4629 *tests/testthat/test-bypqao.R 051416af24d0386f084eb13a14053ce1 *tests/testthat/test-bystate.R 014b81fb9c8d2350e1347841f41b24a3 *tests/testthat/test-helperfunctions.R e897203bb026b43141e5bc00dfe3cecd *tests/testthat/test-RAQSAPlistfunctions.R -b61158a69282efb5764330a69903f09f *vignettes/Acknowledgements.html -c88632127a253c0c0252f83d6684e83f *vignettes/Acknowledgements.Rmd +183ed69a443baffdf0454255cade3fcc *vignettes/Acknowledgements.html +18cea3348cace002e6c706d373beb524 *vignettes/Acknowledgements.Rmd 22d607e5d49e10047a911e5d42183c34 *vignettes/acs-nano.csl 0ec78b946a45069323acf54a24c77566 *vignettes/american-chemical-society.csl -ac521e98550ad829bf3d9b1055022f66 *vignettes/AQSAPI.bib +e1df58c4692ce8a6e9743bf9d594ff9e *vignettes/AQSAPI.bib de323c3deb36e066a7583c5b756ae49b *vignettes/EPA_Disclaimer.html a79d926b2ab509e6a9e575539b205280 *vignettes/EPA_Disclaimer.Rmd 9f8f6638c5178a9bec62665b4cef5e1d *vignettes/figures/AQS_LOGO.png diff --git a/NAMESPACE b/NAMESPACE index bcc2bb2..ababe67 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -104,6 +104,8 @@ importFrom(dplyr,select) importFrom(dplyr,select_if) importFrom(dplyr,vars) importFrom(glue,glue) +importFrom(httr2,last_response) +importFrom(httr2,req_error) importFrom(httr2,req_options) importFrom(httr2,req_perform) importFrom(httr2,req_retry) diff --git a/R/AQSAPI_helperfunctions.R b/R/AQSAPI_helperfunctions.R index c521903..a065b84 100644 --- a/R/AQSAPI_helperfunctions.R +++ b/R/AQSAPI_helperfunctions.R @@ -321,6 +321,42 @@ format_multiple_params_for_api <- function(x, separator=",") } +#' @title RAQSAPI_error_msg +#' +#' @param AQSresponse a httr2 request object +#' @importFrom glue glue +#' @importFrom httr2 last_response resp_body_json +#' @importFrom magrittr `%<>%` +#' +#' @description A helper function that is called by httr2::req_error when an +#' error is encountered performing a request. This function returns +#' a helpful error message for users. This function is not intended +#' to be called directly by end users and should only be called +#' within the aqs function. +#' +#' @return a string error message that is formatted for httr2 to display +#' request errors for end users. +#' @noRd +#' +#' @example None +RAQSAPI_error_msg <- function(AQSresponse) +{ + #nocov start + AQSerr <- last_response() %>% + resp_body_json() + + msg <- glue("At server request time: {AQSresponse$headers$Date} + RAQSAPI experienced an error while processing the following url: + {AQSresponse$url}\n + with status_code: {AQSresponse$status_code} + and status message: {AQSresponse$status} + Server error message: {AQSerr$Header[[1]]$error}") + + return(msg) + #nocov end +} + + #' @title aqs #' @description a helper function sends a AQS RESTful request to the AQS API #' and returns the result as a aqs data type. This helper @@ -357,7 +393,7 @@ format_multiple_params_for_api <- function(x, separator=",") #' @importFrom tibble as_tibble #' @importFrom rlang caller_call #' @importFrom httr2 request req_user_agent req_url_path_append resp_body_json -#' req_perform req_options req_retry req_throttle +#' req_perform req_options req_retry req_throttle req_error #' @return a AQS_DATAMART_APIv2 S3 object that is the return value from the #' AQS API. A AQS_DATAMART_APIv2 is a 2 item named list in which the #' first item ($Header) is a tibble of header information from the @@ -383,7 +419,8 @@ aqs <- function(service, filter = NULL, user = NA, request() %>% req_throttle(rate = 10/60, realm = "RAQSAPI") %>% - req_retry(max_tries = 5, max_seconds = 30, backoff = ~10) + req_retry(max_tries = 5, max_seconds = 30, backoff = ~10) %>% + req_error(body = RAQSAPI_error_msg) # AQS DataMart API does not accept headers so user_agent not working #%>% req_user_agent(string = user_agent) @@ -645,16 +682,16 @@ aqs_services_by_state <- function(parameter, bdate, edate, stateFIPS, { aqs(service = service, - filter = "byState", - user = getOption("aqs_username"), - user_key = getOption("aqs_key"), - variables = list(param = format_multiple_params_for_api(parameter), - bdate = format(bdate, format = "%Y%m%d"), - edate = format(edate, format = "%Y%m%d"), - state = stateFIPS, - duration = duration, - cbdate = cbdate, - cedate = cedate + filter = "byState", + user = getOption("aqs_username"), + user_key = getOption("aqs_key"), + variables = list(param = format_multiple_params_for_api(parameter), + bdate = format(bdate, format = "%Y%m%d"), + edate = format(edate, format = "%Y%m%d"), + state = stateFIPS, + duration = duration, + cbdate = cbdate, + cedate = cedate ), AQS_domain = AQS_domain ) diff --git a/README.md b/README.md index 20b163e..92ca639 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ status](https://www.r-pkg.org/badges/version/RAQSAPI)](https://CRAN.R-project.or downloads](https://cranlogs.r-pkg.org/badges/RAQSAPI)](https://cran.r-project.org/package=RAQSAPI) [![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing) [![license](https://img.shields.io/badge/license-CC0-lightgrey.svg)](https://choosealicense.com/) -“[![Last-changedate](https://img.shields.io/badge/last%20change-%202023--12--29-yellowgreen.svg)](/commits/master)” +“[![Last-changedate](https://img.shields.io/badge/last%20change-%202024--01--03-yellowgreen.svg)](/commits/master)” # EPA Disclaimer @@ -408,13 +408,15 @@ those sources with them RAQSAPI would not be possible. - README badges are provided by R package `badgecreator`5. - The R package `usethis`6 was used to generate GitHub actions for Continuous integration (CI). -- Code cleanup was assisted by the R package `lintr`7 +- Code cleanup was assisted by the R package + `lintr`7 - the function *install.packages* are provided by the R package `utils`8 - the function *install_github* are provided by the R package `remotes`9 - .gitignore file borrowed examples from +- . CITATION.cff file was generated by the R package `cffr`10 # References @@ -501,6 +503,16 @@ Installation from Remote Repositories, Including +
+ +(10) +Druskat, S.; Spaaks, J. H.; Chue +Hong, N.; Haines, R.; Baker, J.; Bliven, S.; Willighagen, E.; +Pérez-Suárez, D.; Konovalov, A. Citation File Format, 2021. +. + +
+ [^1]: RAQSAPI’s rate limit does not guarantee that the user will not go diff --git a/cran-comments.Rmd b/cran-comments.Rmd index 151480b..aa4665b 100644 --- a/cran-comments.Rmd +++ b/cran-comments.Rmd @@ -7,6 +7,8 @@ output: md_document # cran-comments for RAQSAPI ## RAQSAPI 2.0.5 + - Added the ability to display server side messages for errors in API calls. + - Added a new CITATION.cff for thanks to R package cffr. - New hexstciker. - aqs_isavailable no longer accepts the return_header parameter, this function just returns a tibble and not a AQS_Data Mart_APIv2 object. diff --git a/cran-comments.md b/cran-comments.md index 151480b..aa4665b 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -7,6 +7,8 @@ output: md_document # cran-comments for RAQSAPI ## RAQSAPI 2.0.5 + - Added the ability to display server side messages for errors in API calls. + - Added a new CITATION.cff for thanks to R package cffr. - New hexstciker. - aqs_isavailable no longer accepts the return_header parameter, this function just returns a tibble and not a AQS_Data Mart_APIv2 object. diff --git a/vignettes/AQSAPI.bib b/vignettes/AQSAPI.bib index f7576b0..ea66f79 100644 --- a/vignettes/AQSAPI.bib +++ b/vignettes/AQSAPI.bib @@ -138,3 +138,16 @@ @Misc{py3package:pyaqsapi year = {2022}, url = {https://github.com/USEPA/pyaqsapi}, } + +@Misc{package:cffr, + title = {Citation {File} {Format}}, + author = {Stephan Druskat and Jurriaan H. Spaaks and Neil {Chue Hong} and Robert Haines and James Baker and Spencer Bliven and Egon Willighagen and David Pérez-Suárez and Alexander Konovalov}, + year = {2021}, + month = {aug}, + doi = {10.5281/zenodo.5171937}, + url = {https://github.com/citation-file-format/citation-file-format}, + urldate = {2021-11-07}, + copyright = {CC-BY-4.0}, + date = {2021-08}, + abstract = {The Citation File Format lets you provide citation metadata for software or datasets in plaintext files that are easy to read by both humans and machines.}, +} diff --git a/vignettes/Acknowledgements.Rmd b/vignettes/Acknowledgements.Rmd index 3798463..ef9d817 100644 --- a/vignettes/Acknowledgements.Rmd +++ b/vignettes/Acknowledgements.Rmd @@ -24,9 +24,10 @@ with them RAQSAPI would not be possible. * README badges are provided by R package `badgecreator`[@package:badgecreatr]. * The R package `usethis`[@package:usethis] was used to generate GitHub actions for Continuous integration (CI). -* Code cleanup was assisted by the R package `lintr`[@package:lintr] +* Code cleanup was assisted by the R package `lintr`[@package:lintr]data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABIAAAASCAYAAABWzo5XAAAAWElEQVR42mNgGPTAxsZmJsVqQApgmGw1yApwKcQiT7phRBuCzzCSDSHGMKINIeDNmWQlA2IigKJwIssQkHdINgxfmBBtGDEBS3KCxBc7pMQgMYE5c/AXPwAwSX4lV3pTWwAAAABJRU5ErkJggg== * the function *install.packages* are provided by the R package `utils`[@RBase] * the function *install_github* are provided by the R package `remotes`[ @package:remotes] * .gitignore file borrowed examples from https://github.com/github/gitignore/blob/master/R.gitignore +* . CITATION.cff file was generated by the R package `cffr` [@package:cffr]