Peaks and Ratings

.Rbuildignore

@@ -71,3 +71,5 @@ vignettes/Reference_Lists.Rmd
 ^[.]?air[.]toml$
 ^\.vscode$
 environment.yml
+^\.positai$
+^\.claude$

.github/workflows/pkgdown.yaml

@@ -51,7 +51,7 @@ jobs:
             any::ggplot2
             any::sf
             any::patchwork
-            any::maps
+            any::reticulate
             any::leaflet
             any::readxl
             any::gridExtra

.gitignore

@@ -17,3 +17,4 @@ vignettes/*.html
 vignettes/*.R
 /.quarto/
 **/*.quarto_ipynb
+.positai

.gitlab-ci.yml

@@ -40,17 +40,14 @@ build-image:
   services:
   - name: ${DEVOPS_REGISTRY}usgs/docker:20-dind
     alias: docker
-  rules:
-    - changes:
-      - .gitlab-ci.yml
-      - docker/Dockerfile
-      - environment.yml
   script:
     - echo ${CI_REGISTRY_PASSWORD} | docker login -u ${CI_REGISTRY_USER} --password-stdin $CI_REGISTRY
     - docker pull ${CI_REGISTRY_IMAGE}:latest || true
     - docker build 
         -f docker/Dockerfile -t ${CI_REGISTRY_IMAGE}:latest .
     - docker push --all-tags ${CI_REGISTRY_IMAGE}
+  artifacts:
+    expire_in: 5 minutes
 
 buildcheck:
   stage: check
@@ -70,7 +67,7 @@ buildcheck:
   artifacts:
     paths:
       - "*.tar.gz"
-    expire_in: 1 week
+    expire_in: 1 hour
 
 unittests:
   stage: test
@@ -91,7 +88,7 @@ unittests:
         x'
   artifacts:
     when: always
-    expire_in: 1 week
+    expire_in: 1 hour
     paths: 
       - test-out.xml
     reports:
@@ -112,6 +109,8 @@ longtest:
     - if: $RUN_LONG_TESTS == "FALSE"
       when: always
     - when: never
+  artifacts:
+    expire_in: 5 minutes
 
 pages:
   stage: end
@@ -129,18 +128,20 @@ pages:
   artifacts:
     paths:
       - $PAGES_OUTDIR
-    expire_in: 1 week
+    expire_in: 1 hour
 
 Validate Inventory:
-    stage: end
-    only: 
-      - main
-    image: ${INTERNAL_REGISTRY}software/software-management:latest
-    script:
-      - software-management review
-        --project "${CI_PROJECT_PATH}"
-        --ref "${CI_COMMIT_BRANCH}"
-        --type "provisional"
-        --token "${GIT_TOKEN_CUSTOM}"
-    tags:
-        - chs-shared
+  stage: end
+  only: 
+    - main
+  image: ${INTERNAL_REGISTRY}software/software-management:latest
+  script:
+    - software-management review
+      --project "${CI_PROJECT_PATH}"
+      --ref "${CI_COMMIT_BRANCH}"
+      --type "provisional"
+      --token "${GIT_TOKEN_CUSTOM}"
+  tags:
+      - chs-shared
+  artifacts:
+    expire_in: 5 minutes

DESCRIPTION

@@ -68,5 +68,5 @@ Encoding: UTF-8
 BuildVignettes: true
 VignetteBuilder: knitr
 BugReports: https://github.com/DOI-USGS/dataRetrieval/issues
-RoxygenNote: 7.3.3
 Roxygen: list(markdown = TRUE)
+Config/roxygen2/version: 8.0.0

NAMESPACE

@@ -55,6 +55,7 @@ export(read_waterdata_latest_daily)
 export(read_waterdata_metadata)
 export(read_waterdata_monitoring_location)
 export(read_waterdata_parameter_codes)
+export(read_waterdata_peaks)
 export(read_waterdata_ratings)
 export(read_waterdata_samples)
 export(read_waterdata_stats_daterange)

NEWS

@@ -2,14 +2,21 @@ dataRetrieval 2.7.25
 ===================
 * Added read_waterdata_ratings to access USGS rating curves with
 new modern endpoint.
+* Added read_waterdata_peaks to access USGS peak data with
+new modern endpoint.
 * Increase flexibility of chunking by monitoring_location_id by 
-including it as an argument in each relevant function.
+including it as an argument in each relevant waterdata OGC function.
 * Clean up deprecated code.
 * Updated retry strategy to include retry_on_failure = TRUE.
 * Added countries, methods, method-categories, method-citations, and
 citations to possible values in read_waterdata_metadata.
 * Added field_measurements_series_id argument to read_waterdata_field_measurement
 * Removed NWIS tests
+* Introduce an error if user inputs a numeric to any of the "time" arguments.
+Because it is impossible to tell if they intended Dates or POSIX, we cannot
+know for sure and therefore could add incorrect filters to the query.
+* The "id" column that comes back from read_waterdata_fiel_meta was changed to
+field_measurements_series_id to match the expectation of `read_waterdata_field_measurements`
 
 
 

R/AAA.R

@@ -24,7 +24,8 @@ pkg.env <- new.env()
     "continuous",
     "field-measurements-metadata",
     "combined-metadata",
-    "channel-measurements"
+    "channel-measurements",
+    "peaks"
   )
   collections <- c(
     "parameter-codes",

R/construct_api_requests.R

@@ -340,7 +340,7 @@ switch_arg_id <- function(ls, id_name, service) {
 #' dataRetrieval:::format_api_dates(end)
 #' dataRetrieval:::format_api_dates(end, TRUE)
 #'
-#' end <- c(NA, as.POSIXct("2021-01-01 12:15:00"))
+#' end <- as.POSIXct(c(NA, "2021-01-01 12:15:00"))
 #' dataRetrieval:::format_api_dates(end)
 #'
 #' start_end <- as.POSIXct(c("2021-01-01 12:15:00",
@@ -370,38 +370,57 @@ switch_arg_id <- function(ls, id_name, service) {
 #' start <- "2025-10-01"
 #' end <- Sys.Date()
 #' dataRetrieval:::format_api_dates(c(start, end), date = TRUE)
+#'
+#' # This is a problem because the first value forces the
+#' # vector to be numeric, and then we don't really
+#' # know if the 2nd value is a Date (number of days since 1970)
+#' # or if it's a date/time (number of seconds..)
+#' half_range <- c(NA, as.Date("2025-01-01"))
+#' # Will error:
+#' #dataRetrieval:::format_api_dates(half_range, date = FALSE)
+#' # Better way to do it:
+#' better_half <- as.Date(c(NA, "2025-01-01"))
+#' dataRetrieval:::format_api_dates(better_half, date = FALSE)
 format_api_dates <- function(datetime, date = FALSE) {
   if (is.character(datetime)) {
     datetime[datetime == ""] <- NA
     datetime <- toupper(datetime)
   }
 
-  if (all(is.na(datetime))) {
-    return(NA)
-  }
-
-  if (all(is.null(datetime))) {
+  if (all(is.na(datetime)) | all(is.null(datetime))) {
     return(NA)
   }
 
   if (length(datetime) > 2) {
     stop("datetime should only include 1-2 values")
   }
 
+  if (is.numeric(datetime)) {
+    # Until we can figure out a way to know if the
+    # original input was suppose to be Date or Posix
+    # We can't determine what the user meant.
+    stop(
+      "A time query was entered as numeric. This could lead to errors.
+Check any time queries that might have been automatically converted to numeric.
+This could happen if you use c(NA, as.Date(Sys.Date())) instead of
+as.Date(c(NA, Sys.Date()) for example."
+    )
+  }
+
   if (length(datetime) == 1) {
     # If the user has "P" or the "/" we assume they know what they are doing
     if (
       grepl("P", datetime, ignore.case = TRUE) |
         grepl("/", datetime)
     ) {
       return(datetime)
+    }
+
+    if (date) {
+      datetime <- get_Date(datetime)
     } else {
-      if (date) {
-        datetime <- get_Date(datetime)
-      } else {
-        datetime1 <- get_dateTime(datetime)
-        datetime <- lubridate::format_ISO8601(datetime1, usetz = "Z")
-      }
+      datetime1 <- get_dateTime(datetime)
+      datetime <- lubridate::format_ISO8601(datetime1, usetz = "Z")
     }
   } else if (length(datetime) == 2) {
     if (date) {

R/dataRetrieval-package.R

@@ -207,7 +207,7 @@ NULL
 #               "monitoring-locations", "latest-continuous",
 #               "field-measurements", "latest-daily",
 #               "continuous", "field-measurements-metadata",
-#               "combined-metadata", "channel-measurements")
+#               "combined-metadata", "channel-measurements", "peaks")
 #
 # property_list <- list()
 # for(service in services){

R/readNWISunit.R

@@ -58,25 +58,10 @@
 #' endDate <- "2014-10-10"
 #' \donttest{
 #'
-#' rawData <- readNWISuv(site_id, parameterCd, startDate, endDate)
+#' #rawData <- readNWISuv(site_id, parameterCd, startDate, endDate)
 #'
-#' rawData_today <- readNWISuv(site_id, parameterCd, Sys.Date(), Sys.Date())
+#' #rawData_today <- readNWISuv(site_id, parameterCd, Sys.Date(), Sys.Date())
 #'
-#' timeZoneChange <- readNWISuv(
-#'   c("04024430", "04024000"), parameterCd,
-#'   "2013-11-03", "2013-11-03"
-#' )
-#'
-#' centralTime <- readNWISuv(site_id, parameterCd,
-#'   "2014-10-10T12:00", "2014-10-10T23:59",
-#'   tz = "America/Chicago"
-#' )
-#'
-#' # Adding 'Z' to the time indicates to the web service to call the data with UTC time:
-#' GMTdata <- readNWISuv(
-#'   site_id, parameterCd,
-#'   "2014-10-10T00:00Z", "2014-10-10T23:59Z"
-#' )
 #' }
 readNWISuv <- function(
   siteNumbers,
@@ -171,12 +156,12 @@ readNWISuv <- function(
 #' @seealso [constructNWISURL()], [importRDB1()]
 #' @export
 #' @examplesIf is_dataRetrieval_user()
-#' site_ids <- c("01594440", "040851325")
+#' #site_ids <- c("01594440", "040851325")
 #' \donttest{
-#' data <- readNWISpeak(site_ids)
-#' data2 <- readNWISpeak(site_ids, asDateTime = FALSE)
-#' stations <- c("06011000")
-#' peakdata <- readNWISpeak(stations, convertType = FALSE)
+#' #data <- readNWISpeak(site_ids)
+#' #data2 <- readNWISpeak(site_ids, asDateTime = FALSE)
+#' #stations <- c("06011000")
+#' #peakdata <- readNWISpeak(stations, convertType = FALSE)
 #' }
 readNWISpeak <- function(
   siteNumbers,
@@ -185,8 +170,11 @@ readNWISpeak <- function(
   asDateTime = TRUE,
   convertType = TRUE
 ) {
-  message(new_nwis_message())
-
+  .Deprecated(
+    new = "read_waterdata_peaks",
+    package = "dataRetrieval",
+    msg = "NWIS servers are slated for decommission. Please begin to migrate to read_waterdata_peaks."
+  )
   # Doesn't seem to be a peak xml service
   url <- constructNWISURL(
     siteNumbers = siteNumbers,
@@ -276,8 +264,8 @@ readNWISpeak <- function(
 #' @examplesIf is_dataRetrieval_user()
 #' site_id <- "01594440"
 #' \donttest{
-#' data <- readNWISrating(site_id, "base")
-#' attr(data, "RATING")
+#' #data <- readNWISrating(site_id, "base")
+#' #attr(data, "RATING")
 #' }
 readNWISrating <- function(siteNumber, type = "base", convertType = TRUE) {
   .Deprecated(
@@ -354,28 +342,28 @@ readNWISrating <- function(siteNumber, type = "base", convertType = TRUE) {
 #' @export
 #' @examplesIf is_dataRetrieval_user()
 #' \donttest{
-#' x1 <- readNWISstat(
-#'   siteNumbers = c("02319394"),
-#'   parameterCd = c("00060"),
-#'   statReportType = "annual"
-#' )
+#' # x1 <- readNWISstat(
+#' #   siteNumbers = c("02319394"),
+#' #   parameterCd = c("00060"),
+#' #   statReportType = "annual"
+#' # )
 #'
 #' # all the annual mean discharge data for two sites
-#' x2 <- readNWISstat(
-#'   siteNumbers = c("02319394", "02171500"),
-#'   parameterCd = c("00010", "00060"),
-#'   statReportType = "annual"
-#' )
+#' #x2 <- readNWISstat(
+#' #   siteNumbers = c("02319394", "02171500"),
+#' #   parameterCd = c("00010", "00060"),
+#' #   statReportType = "annual"
+#' # )
 #'
 #' # Request p25, p75, and mean values for temperature and discharge for the 2000s
 #' # Note that p25 and p75 were not available for temperature, and return NAs
-#' x <- readNWISstat(
-#'   siteNumbers = c("02171500"),
-#'   parameterCd = c("00010", "00060"),
-#'   statReportType = "daily",
-#'   statType = c("mean", "median"),
-#'   startDate = "2000", endDate = "2010"
-#' )
+#' #x <- readNWISstat(
+#' #   siteNumbers = c("02171500"),
+#' #   parameterCd = c("00010", "00060"),
+#' #   statReportType = "daily",
+#' #   statType = c("mean", "median"),
+#' #   startDate = "2000", endDate = "2010"
+#' # )
 #' }
 readNWISstat <- function(
   siteNumbers,