diff --git a/MD5 b/MD5 index e38bb3a..4552ded 100644 --- a/MD5 +++ b/MD5 @@ -5,7 +5,7 @@ 4fc13def6ec5d889261f1f22a13ba542 *dev/contributing.Rmd 74e297a0dc0b508ed18e3821264958d0 *dev/countlinesofcode.R 204b6f5c7aac2b4273b03f8d09e6e90f *dev/hexsticker.R -5d53eb789b68a9cfed41532487f78de6 *dev/install_RAQSAPI.R +25ba12c80c0967d76eb3e684a5b1925d *dev/install_RAQSAPI.R 5f3c708ae9a7e3610961d99f3375e60f *inst/CITATION 3df907b50c4f00bc26ee6d988e0c849f *inst/codecov.yml bda06ff6cafff22a1e8b6f2e57f11d03 *inst/WORDLIST @@ -36,16 +36,16 @@ af6b0d11899cf5785207f49e2c9f74b8 *man/aqs_isavailable.Rd 42928aa2d54e621122cf4347a1a20eed *man/aqs_monitors_by_state.Rd 1ecd0336719cce3614a394608f0c0bfa *man/aqs_parameters_by_class.Rd 1118554a6262bd0d66bbca6d9d25f72c *man/aqs_pqaos.Rd -8f11edf7569ee3f1e61a93748f92eb91 *man/aqs_qa_annualpeferomanceeval_by_MA.Rd +babaa112e77ece2359d28b29efc0a9f0 *man/aqs_qa_annualpeferomanceeval_by_MA.Rd 208861822882440ac4cd00389ff113e6 *man/aqs_qa_annualpeferomanceeval_by_pqao.Rd 00049e8a856aebc1f52cb523207656cc *man/aqs_qa_annualpeferomanceeval_by_site.Rd 9d7be3f72a74e3fc9c118c54f07f3e21 *man/aqs_qa_annualpeferomanceeval_by_state.Rd 4ecbe50d8fbeab9ef0b842a250487dd0 *man/aqs_qa_annualperformanceeval_by_county.Rd 835ce9dd933d679ba893f9954ed1b48c *man/aqs_qa_annualperformanceevaltransaction_by_county.Rd -14de56fac26eb9a1ad97dcb1655565e9 *man/aqs_qa_annualperformanceevaltransaction_by_MA.Rd +f0f405e8c82b7978127b6b306ac6b211 *man/aqs_qa_annualperformanceevaltransaction_by_MA.Rd b0425e7feb4dc99a4d0eeec51f50e2be *man/aqs_qa_annualperformanceevaltransaction_by_pqao.Rd -2e94a2e015d73091284e2ed4e9ea9b62 *man/aqs_qa_annualperformanceevaltransaction_by_site.Rd -b03a30ba2af81233daf8f2d28cc87eb2 *man/aqs_qa_annualperformanceevaltransaction_by_state.Rd +3979f13af8b8f98593fd6825ff4633ca *man/aqs_qa_annualperformanceevaltransaction_by_site.Rd +b7451a44076a5a1afb1fb8d90c641622 *man/aqs_qa_annualperformanceevaltransaction_by_state.Rd 03997dd7bd8a1abb9c47b260e12c2574 *man/aqs_qa_blanks_by_county.Rd aef05672309b1f1bed0fadd5de01c845 *man/aqs_qa_blanks_by_MA.Rd 2aca341c7e46ae8a5e2151fef001759b *man/aqs_qa_blanks_by_pqao.Rd @@ -112,22 +112,22 @@ c3978703d8f40f2679795335715e98f4 *man/figures/lifecycle-experimental.svg 53b3f893324260b737b3c46ed2a0e643 *man/figures/lifecycle-stable.svg 1c1fe7a759b86dc6dbcbe7797ab8246c *man/figures/lifecycle-superseded.svg 18243069a67e5dd712a382ba394b8405 *man/RAQSAPI.Rd -bd1421bf3ffa3468b52ed7bf46c7b561 *NAMESPACE +326f662930cb97e920695e42bbf77ba3 *NAMESPACE bd3e694dd41b71c72eae576547f1e935 *NEWS.md -7ac69d4cf4c08bc98fefee351fe8e37c *R/AQSAPI_helperfunctions.R +0aa07778999cac9c23ab747cf9c3883a *R/AQSAPI_helperfunctions.R 774aedd99bd08b38bf1b3ac142218c7f *R/bybox.R 1f6fb5ce5c7a083e2a8d89ac5f3954bd *R/bycbsa.R 18e42ea4f9b75252b743c78787a67726 *R/bycounty.R -b5530339805edf468db4acc18ac9368c *R/byma.R +d16d3567ecab009f4ff1c5cd8666b555 *R/byma.R 22cca955312e40732ece53cbd1ed3098 *R/bypqao.R -70ca2d5dae65d6e6cdd8ceea6df1dfc2 *R/bysite.R -fd018205faf77c594e9b3edee55e04f6 *R/bystate.R +6e55935c68d6ec6c08a068d729ad4501 *R/bysite.R +b0fe155cfc161bd08127bae9a645b446 *R/bystate.R b965ba52e0a9b9f12cb0d5cff9b78355 *R/RAQSAPI-package.R c325fd8eb2346bd402e665de97f35c5c *R/RAQSAPIlistfunctions.R 4c1d32f0972205697bec23f1873ceed0 *R/setupfunctions.R 735b109c7a7497e7e4000c520b5ba37f *R/zzz.R a69de5455537022556f014579766be59 *RAQSAPI.Rproj -4fa57170f7480a49aa7e7b1d8a20aea8 *README.md +06217bf35112a959bb34b6a65de52860 *README.md 201526debb59c4f79c28fd34fd8f30c1 *README.Rmd 34952a5944548ea4fc132a9899f8e6ab *revdep/email.yml 332173f20d20942c02019350ea4dcadc *tests/spelling.R @@ -140,9 +140,8 @@ f512d04635ce70a76c82fe237c92c4c7 *tests/testthat/test-byCBSA.R 78bfc3173dcfd9767f834465abbff965 *tests/testthat/test-bypqao.R 8201db112d2397a4e01ef2f21b1f2223 *tests/testthat/test-bysite.R 83e5695ad314bbe2898448c2f7f0541c *tests/testthat/test-bystate.R -080458dec76fab77682282c9a5914ee1 *tests/testthat/test-helperfunctions.R +ced8e7ef1890a4f75a3e290487482ffa *tests/testthat/test-helperfunctions.R a675cf8edbbbc56dfa8c4934abbae204 *tests/testthat/test-RAQSAPIlistfunctions.R -1297dfdb3192970d4437e5ecf8f90202 *tests/testthat/test-RAQSAPlistfunctions.R 8e814c1a4b8e8547c5dd0da4f1608422 *vignettes/Acknowledgements.html 34518335694d92be6153b2f242e09fa4 *vignettes/Acknowledgements.Rmd 22d607e5d49e10047a911e5d42183c34 *vignettes/acs-nano.csl diff --git a/NAMESPACE b/NAMESPACE index b151fe6..1dd4fbb 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -127,6 +127,7 @@ importFrom(rlang,call_frame) importFrom(rlang,format_error_bullets) importFrom(rlang,is_character) importFrom(stringr,str_c) +importFrom(stringr,str_detect) importFrom(tibble,as_tibble) importFrom(tibble,tibble) importFrom(utils,tail) diff --git a/R/AQSAPI_helperfunctions.R b/R/AQSAPI_helperfunctions.R index 6d6bb30..411f3e5 100644 --- a/R/AQSAPI_helperfunctions.R +++ b/R/AQSAPI_helperfunctions.R @@ -19,6 +19,7 @@ server <- "AQSDatamartAPI" #' @importFrom dplyr between #' @importFrom glue glue #' @importFrom magrittr `%<>%` +#' @importFrom stringr str_detect #' @return NULL #' @noRd checkaqsparams <- function(...) @@ -120,8 +121,8 @@ checkaqsparams <- function(...) { error <- TRUE errmessage %<>% c('x' = - "cbsa_code must be a five digit number (represented as a character string), - please pad cbsa_code less than five digits with leading zeros" + "cbsa_code must be a five digit number (represented as a character + string), please pad cbsa_code less than five digits with leading zeros" ) } } diff --git a/R/byma.R b/R/byma.R index bb0a44c..e7b3ba1 100644 --- a/R/byma.R +++ b/R/byma.R @@ -495,8 +495,8 @@ aqs_transactionsample_by_MA <- function(parameter, bdate, edate, MA_code, #' format = "%Y%m%d"), #' edate = as.Date("20171231", #' format = "%Y%m%d"), -#' MA_code = "0013" -#' ) +#' MA_code = "0013" +#' ) #' } #' @return a tibble or an AQS_Data Mart_APIv2 S3 object of quality assurance #' performance evaluation data. for single monitoring site for the @@ -533,8 +533,8 @@ aqs_qa_annualpeferomanceeval_by_MA <- function(parameter, bdate, edate, #' for a parameter code aggregated by matching input parameter and #' MA_code provided for bdate - edate time frame. #' @note The AQS API only allows for a single year of quality assurance Annual -#' Performance Evaluation transaction data to be retrieved at a time. This -#' function conveniently extracts date information from the bdate +#' Performance Evaluation transaction data to be retrieved at a time. +#' This function conveniently extracts date information from the bdate #' and edate parameters then makes repeated calls to the AQSAPI #' retrieving a maximum of one calendar year of data at a time. Each #' calendar year of data requires a separate API call so multiple years diff --git a/R/bysite.R b/R/bysite.R index 705f693..d8be8e8 100644 --- a/R/bysite.R +++ b/R/bysite.R @@ -900,7 +900,7 @@ aqs_qa_annualpeferomanceeval_by_site <- function(parameter, bdate, edate, #' @examples #Returns an AQS_Data Mart_APIv2 S3 object or a tibble #' # containing annual performance evaluation data (raw) for ozone #' # at the Fairhope site in Baldwin County, AL for 2017 in RD format. -#' \dontrun{aqs_qa_annualperformanceevaltransaction_by_site(parameter = "44201", +#' \dontrun{aqs_qa_annualperformanceevaltransaction_by_site(parameter = "44201", #' bdate = as.Date("20170101", #' format = "%Y%m%d"), #' edate = as.Date("20171231", diff --git a/R/bystate.R b/R/bystate.R index 93b57ce..e98f205 100644 --- a/R/bystate.R +++ b/R/bystate.R @@ -809,14 +809,15 @@ aqs_qa_annualpeferomanceeval_by_state <- function(parameter, bdate, edate, #' @examples #Returns an AQS_Data Mart_APIv2 S3 object or a tibble #' # containing annual performance evaluation data for ozone in #' # Alabmba for 2017 in RD format. -#' \dontrun{ aqs_qa_annualperformanceevaltransaction_by_state(parameter = "44201", +#' \dontrun{ +#' aqs_qa_annualperformanceevaltransaction_by_state(parameter = "44201", #' bdate = as.Date("20170101", #' format = "%Y%m%d"), #' edate = as.Date("20171231", #' format = "%Y%m%d") #' stateFIPS = "01" -#' ) -#' } +#' ) +#' } #' @return a tibble or an AQS_Data Mart_APIv2 S3 object of quality assurance #' performance evaluation data. for single monitoring site for the #' sitenum, countycode and stateFIPS requested for the time frame diff --git a/README.md b/README.md index e5b8a22..4bf585f 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,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-%202021--11--26-blue.svg)](/commits/master) +[![Last-changedate](https://img.shields.io/badge/last%20change-%202021--11--27-blue.svg)](/commits/master) # EPA Disclaimer diff --git a/dev/install_RAQSAPI.R b/dev/install_RAQSAPI.R index 35f1929..764ffff 100644 --- a/dev/install_RAQSAPI.R +++ b/dev/install_RAQSAPI.R @@ -83,7 +83,7 @@ RAQSAPIBUILD <- function() { buildRAQSAPIbase() build_manual() - devtools::build(binary = TRUE, quiet = TRUE, manual = TRUE) + devtools::build(binary = FALSE, quiet = TRUE, manual = TRUE) } @@ -150,5 +150,5 @@ RAQSAPICHECK <- function() if ("RAQSAPI" %in% .packages()) {detach("package:RAQSAPI", unload = TRUE)} goodpractice::gp(quiet = TRUE) devtools::revdep(pkg = "RAQSAPI", recursive = TRUE) - if (!tools::checkMD5sums(dir = ".")) { warning("checkMD5sums, failed") } + if (!tools::checkMD5sums(dir = ".")) { warning("checkMD5sums failed") } } diff --git a/man/aqs_qa_annualpeferomanceeval_by_MA.Rd b/man/aqs_qa_annualpeferomanceeval_by_MA.Rd index fb7197d..98f82a4 100644 --- a/man/aqs_qa_annualpeferomanceeval_by_MA.Rd +++ b/man/aqs_qa_annualpeferomanceeval_by_MA.Rd @@ -73,8 +73,8 @@ server. This operation has a linear run time of format = "\%Y\%m\%d"), edate = as.Date("20171231", format = "\%Y\%m\%d"), - MA_code = "0013" - ) + MA_code = "0013" + ) } } \seealso{ diff --git a/man/aqs_qa_annualperformanceevaltransaction_by_MA.Rd b/man/aqs_qa_annualperformanceevaltransaction_by_MA.Rd index e8504e9..6e2549d 100644 --- a/man/aqs_qa_annualperformanceevaltransaction_by_MA.Rd +++ b/man/aqs_qa_annualperformanceevaltransaction_by_MA.Rd @@ -52,8 +52,8 @@ MA_code provided for bdate - edate time frame. } \note{ The AQS API only allows for a single year of quality assurance Annual -Performance Evaluation transaction data to be retrieved at a time. This -function conveniently extracts date information from the bdate +Performance Evaluation transaction data to be retrieved at a time. +This function conveniently extracts date information from the bdate and edate parameters then makes repeated calls to the AQSAPI retrieving a maximum of one calendar year of data at a time. Each calendar year of data requires a separate API call so multiple years diff --git a/man/aqs_qa_annualperformanceevaltransaction_by_site.Rd b/man/aqs_qa_annualperformanceevaltransaction_by_site.Rd index c94b4ba..db9ff9a 100644 --- a/man/aqs_qa_annualperformanceevaltransaction_by_site.Rd +++ b/man/aqs_qa_annualperformanceevaltransaction_by_site.Rd @@ -96,7 +96,7 @@ server. This operation has a linear run time of #Returns an AQS_Data Mart_APIv2 S3 object or a tibble # containing annual performance evaluation data (raw) for ozone # at the Fairhope site in Baldwin County, AL for 2017 in RD format. - \dontrun{aqs_qa_annualperformanceevaltransaction_by_site(parameter = "44201", +\dontrun{aqs_qa_annualperformanceevaltransaction_by_site(parameter = "44201", bdate = as.Date("20170101", format = "\%Y\%m\%d"), edate = as.Date("20171231", diff --git a/man/aqs_qa_annualperformanceevaltransaction_by_state.Rd b/man/aqs_qa_annualperformanceevaltransaction_by_state.Rd index 6aa5b54..eb32e6c 100644 --- a/man/aqs_qa_annualperformanceevaltransaction_by_state.Rd +++ b/man/aqs_qa_annualperformanceevaltransaction_by_state.Rd @@ -69,14 +69,15 @@ server. This operation has a linear run time of #Returns an AQS_Data Mart_APIv2 S3 object or a tibble # containing annual performance evaluation data for ozone in # Alabmba for 2017 in RD format. - \dontrun{ aqs_qa_annualperformanceevaltransaction_by_state(parameter = "44201", +\dontrun{ + aqs_qa_annualperformanceevaltransaction_by_state(parameter = "44201", bdate = as.Date("20170101", format = "\%Y\%m\%d"), edate = as.Date("20171231", format = "\%Y\%m\%d") stateFIPS = "01" - ) - } + ) + } } \seealso{ Other Aggregate _by_state functions: diff --git a/tests/testthat/test-RAQSAPlistfunctions.R b/tests/testthat/test-RAQSAPlistfunctions.R deleted file mode 100644 index 5592d04..0000000 --- a/tests/testthat/test-RAQSAPlistfunctions.R +++ /dev/null @@ -1,48 +0,0 @@ -#' @importFrom magrittr `%>%`() -test_that("list functions", { -testthat::skip_if_offline() -testthat::skip_on_cran() -server <- "AQSDatamartAPI" -datamartAPI_user <- "test@aqs.api" - -datamartAPI_user <- "test@aqs.api" - - aqs_credentials(username = datamartAPI_user, - key = "test" - ) - - aqs_isavailable(return_header = TRUE)$Header$status %>% - expect_match(regexp = "API service is up and running healthy", - fixed = FALSE - ) - - aqs_fields_by_service(service = "list", - return_header = TRUE)$Header$status %>% - expect_match(regexp = "Success") - - aqs_knownissues(return_header = TRUE)$Header$status %>% - expect_match(regexp = "Success") - - aqs_revisionhistory(return_header = TRUE)$Header$status %>% - expect_match(regexp = "Success") - - aqs_states(return_header = TRUE)$Header$status %>% - expect_match(regexp = "Success") - - aqs_counties_by_state(stateFIPS = "40", - return_header = TRUE - )$Header$status %>% - expect_match(regexp = "Success") - - aqs_classes(return_header = TRUE)$Header$status %>% - expect_match(regexp = "Success") - -aqs_sites_by_county(stateFIPS = "15", - countycode = "001", - return_header = TRUE)$Header$status %>% - expect_match(regexp = "Success") - -aqs_parameters_by_class(class = "CRITERIA", - return_header = TRUE)$Header$status %>% - expect_match(regexp = "Success") -}) diff --git a/tests/testthat/test-helperfunctions.R b/tests/testthat/test-helperfunctions.R index d4d5130..b8b7e1a 100644 --- a/tests/testthat/test-helperfunctions.R +++ b/tests/testthat/test-helperfunctions.R @@ -1,18 +1,10 @@ #' @importFrom magrittr `%>%`() +#' @importFrom stringr str_detect test_that("helperfunctions (checkaqsparams()) functions", { testthat::skip_if_offline() testthat::skip_on_cran() server <- "AQSDatamartAPI" -# RAQSAPI::checkaqsparams(parameter = "abcdefg", date = 1995, -# stateFIPS = "90210", countycode = "341478", -# sitenum = "1", cbsa_code = "something", -# pqao_code = "9999", minlat = "3245253", -# maxlat = "647352", minlon = 45425252, -# maxlat = 463753415, ma_code = "MA", -# return_header = 1) %>% -# expect_error() - RAQSAPI::checkaqsparams(parameter = "abcdefg") %>% expect_error() RAQSAPI::checkaqsparams(bdate = 1995) %>%