Add statistics functions

.Rbuildignore

@@ -108,3 +108,4 @@ vignettes/wqpData.rds
 _quarto.yml
 vignettes/basic_slides.Rmd
 vignettes/changes_slides.Rmd
+vignettes/daily_data_statistics.Rmd

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: dataRetrieval
 Type: Package
 Title: Retrieval Functions for USGS and EPA Hydrology and Water Quality Data
-Version: 2.7.22
+Version: 2.7.22.9000
 Authors@R: c(
     person("Laura", "DeCicco", role = c("aut","cre"),
             email = "ldecicco@usgs.gov",
@@ -26,7 +26,7 @@ Authors@R: c(
             comment=c(ORCID = "0000-0003-2521-5043")),
     person("Lee", "Stanish", role="ctb",
             comment=c(ORCID = "0000-0002-9775-6861")),
-    person("Joeseph", "Zemmels", role="ctb",
+    person("Joseph", "Zemmels", role="ctb",
             email = "jzemmels@usgs.gov",
             comment=c(ORCID = "0009-0008-1463-6313")),
     person("Elise", "Hinman", role="aut",
@@ -55,7 +55,8 @@ Imports:
     jsonlite,
     httr2,
     whisker,
-    sf
+    sf,
+    data.table
 Suggests:
     covr,
     dplyr,

NAMESPACE

@@ -6,7 +6,6 @@ export(checkWQPdates)
 export(check_OGC_requests)
 export(check_waterdata_sample_params)
 export(constructNWISURL)
-export(constructUseURL)
 export(constructWQPURL)
 export(construct_api_requests)
 export(construct_waterdata_sample_request)
@@ -56,6 +55,8 @@ export(read_waterdata_metadata)
 export(read_waterdata_monitoring_location)
 export(read_waterdata_parameter_codes)
 export(read_waterdata_samples)
+export(read_waterdata_stats_daterange)
+export(read_waterdata_stats_por)
 export(read_waterdata_ts_meta)
 export(renameNWISColumns)
 export(setAccess)
@@ -71,3 +72,12 @@ export(whatWQPsamples)
 export(whatWQPsites)
 export(wqp_check_status)
 export(zeroPad)
+importFrom(data.table,":=")
+importFrom(data.table,.BY)
+importFrom(data.table,.EACHI)
+importFrom(data.table,.GRP)
+importFrom(data.table,.I)
+importFrom(data.table,.N)
+importFrom(data.table,.NGRP)
+importFrom(data.table,.SD)
+importFrom(data.table,data.table)

NEWS

@@ -1,3 +1,14 @@
+dataRetrieval 2.7.22.9000
+===================
+* Added data.table to Imports
+* Added data.table importFrom entries to NAMESPACE
+* Added read_waterdata_stats_por and read_waterdata_stats_daterange to access USGS daily data statistics.
+* Updated vignettes, examples, and README to reflect new stats functions.
+* Added tests for read_waterdata_stats functions
+* Updated next_req_url to allow paging through /statistics API output
+* Added deprecate message to readNWISstat function.
+
+
 dataRetrieval 2.7.22
 ===================
 * Added read_waterdata_latest_daily to access latest daily USGS water data.

R/constructNWISURL.R

@@ -35,9 +35,7 @@
 #' provide statistics for each month and year within the range individually.
 #' @param statType character Only used for statistics service requests. Type(s)
 #' of statistics to output for daily values.  Default is mean, which is the only
-#' option for monthly and yearly report types. See the statistics service documentation
-#' at <https://waterservices.usgs.gov/docs/statistics/> for a
-#' full list of codes.
+#' option for monthly and yearly report types. 
 #' @keywords data import USGS web service
 #' @return url string
 #' @export
@@ -431,63 +429,4 @@ constructWQPURL <- function(siteNumbers,
   return(baseURL)
 }
 
-#' Construct URL for NWIS water use data service
-#'
-#' Reconstructs URLs to retrieve data from here: <https://waterdata.usgs.gov/nwis/wu>
-#'
-#' @param years integer Years for data retrieval. Must be years ending in 0 or 5,
-#' or "ALL", which retrieves all available years.
-#' @param stateCd could be character (full name, abbreviation, id), or numeric (id)
-#' @param countyCd could be numeric (County IDs from countyCdLookup) or character ("ALL")
-#' @param categories character Two-letter cateogory abbreviation(s)
-#' @return url string
-#' @export
-#' @examples
-#' url <- constructUseURL(
-#'   years = c(1990, 1995),
-#'   stateCd = "Ohio",
-#'   countyCd = c(1, 3),
-#'   categories = "ALL"
-#' )
-#'
-constructUseURL <- function(years, stateCd, countyCd, categories) {
-
-
-  if (is.null(stateCd)) {
-    baseURL <- httr2::request(pkg.env[["useNat"]])
-    baseURL <- httr2::req_url_query(baseURL,
-                                    format = "rdb",
-                                    rdb_compression = "value")
-  } else {
-
-    stateCd <- stateCdLookup(input = stateCd, outputType = "postal")
-    baseURL <- httr2::request("https://waterdata.usgs.gov/")
-    baseURL <- httr2::req_url_path_append(baseURL, stateCd) 
-    baseURL <- httr2::req_url_path_append(baseURL, 
-                                          "nwis", "water_use") 
-    baseURL <- httr2::req_url_query(baseURL,
-                                    format = "rdb",
-                                    rdb_compression = "value")
-
-    if (!(is.null(countyCd) )) {
-
-      baseURL <- httr2::req_url_query(baseURL, 
-                                      wu_area = "county")
-      baseURL <- httr2::req_url_query(baseURL,
-                                      wu_county = countyCd, 
-                                      .multi = "comma")
-    } else {
-      baseURL <- httr2::req_url_query(baseURL,
-                                      wu_area = "State Total")
-    }
-  }
 
-  baseURL <- httr2::req_url_query(baseURL, 
-                                  wu_year = years, 
-                                  .multi = "comma")
-  baseURL <- httr2::req_url_query(baseURL, 
-                                  wu_category = categories,
-                                  .multi = "comma")
-
-  return(baseURL)
-}

R/dataRetrievals-package.R → R/dataRetrieval-package.R

@@ -58,13 +58,8 @@ token_message)
 #'
 #' @docType data
 #' @export parameterCdFile
-#' @examplesIf is_dataRetrieval_user()
-#' 
-#' \donttest{
-#' # Please migrate to:
-#' parameterCds <- read_waterdata_metadata("parameter-codes")
-#' 
-#' }
+#' @examples
+#' head(parameterCdFile[, 1:2])
 NULL
 
 
@@ -118,13 +113,8 @@ NULL
 #' @docType data
 #' @export stateCd
 #' @keywords USGS stateCd
-#' @examplesIf is_dataRetrieval_user()
-#' 
-#' \donttest{
-#' # Please migrate to:
-#' stateCd <- read_waterdata_metadata("states")
-#' 
-#' }
+#' @examples
+#' head(stateCd)
 NULL
 
 #' US County Code Lookup Table
@@ -146,15 +136,24 @@ NULL
 #' @docType data
 #' @export countyCd
 #' @keywords USGS countyCd
-#' @examplesIf is_dataRetrieval_user()
-#' 
-#' \donttest{
-#' # Please migrate to:
-#' countyCd <- read_waterdata_metadata("counties")
-#' 
-#' }
+#' @examples
+#' head(countyCd)
+NULL
+
+## usethis namespace: start
+#' @importFrom data.table data.table
+#' @importFrom data.table :=
+#' @importFrom data.table .SD
+#' @importFrom data.table .BY
+#' @importFrom data.table .N
+#' @importFrom data.table .I
+#' @importFrom data.table .GRP
+#' @importFrom data.table .NGRP
+#' @importFrom data.table .EACHI
+## usethis namespace: end
 NULL
 
+
 # nolint start: commented_code_linter
 # Here's how to incorporate the state_county.json into the historic
 # sysdata.rda. The original data included some IDs that aren't in the json
@@ -205,21 +204,4 @@ NULL
 # 
 # save(countyCd, stateCd, parameterCdFile, pCodeToName,
 #      file = "R/sysdata.rda", compress = "xz")
-# 
-# services <- c("daily", "time-series-metadata",
-#               "monitoring-locations", "latest-continuous",
-#               "field-measurements", "latest-daily",
-#               "continuous")
-# 
-# property_list <- list()
-# 
-# for(i in services){
-#   schema <- check_OGC_requests(endpoint = i, type = "schema")
-#   properties <- names(schema$properties)
-#   property_list[[i]] <- properties
-# }
-# rm(schema, i, services, properties)
-# save(countyCd, stateCd, parameterCdFile, pCodeToName, property_list, offsetLibrary,
-#      file = "R/sysdata.rda", compress = "xz")
-# 
-# # nolint end
+# nolint end

R/readNWISunit.R

@@ -610,6 +610,10 @@ readNWISgwl <- function(siteNumbers,
 #' }
 readNWISstat <- function(siteNumbers, parameterCd, startDate = "", endDate = "", convertType = TRUE,
                          statReportType = "daily", statType = "mean") {
+
+  .Deprecated(new = "read_waterdata_stats_por",
+              package = "dataRetrieval", 
+              msg = "NWIS servers are slated for decommission. Please begin to migrate to either read_waterdata_stats_por or read_waterdata_stats_daterange.")
 
   message(new_nwis_message())
   # check for NAs in site numbers