Merge branch 'master' of https://github.com/tbep-tech/tbeptools

Author: fawda123

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: tbeptools
 Title: Data and Indicators for the Tampa Bay Estuary Program
-Version: 3.1.0.9022
-Date: 2026-01-29
+Version: 3.1.0.9023
+Date: 2026-02-01
 Authors@R: c(
     person(given = "Marcus",
       family = "Beck",
@@ -74,7 +74,6 @@ Imports:
   purrr,
   reactable,
   readxl,
-  rnoaa,
   rvest,
   sf,
   terra,
@@ -95,8 +94,6 @@ Suggests:
   rmarkdown,
   testthat (>= 2.1.0),
   covr
-Remotes:
-  ropensci/rnoaa
 License: MIT + file LICENSE
 Encoding: UTF-8
 VignetteBuilder: knitr

NAMESPACE

@@ -104,6 +104,7 @@ export(util_importwqwa)
 export(util_importwqwin)
 export(util_map)
 export(util_orgin)
+export(util_rain)
 import(dplyr)
 import(ggplot2)
 import(patchwork)
@@ -163,7 +164,6 @@ importFrom(plotly,subplot)
 importFrom(purrr,map)
 importFrom(purrr,pwalk)
 importFrom(reactable,colDef)
-importFrom(rnoaa,ncdc)
 importFrom(rvest,html_node)
 importFrom(rvest,html_table)
 importFrom(rvest,read_html)

R/anlz_hydroload.R

@@ -7,14 +7,12 @@
 #' @param trace logical indicating if function progress is printed in the consol
 #'
 #' @details
-#' This function uses rainfall and streamflow data from NOAA and USGS and requires an API key.  See the "Authentication" section under the help file for ncdc in the defunct rnoaa package.  This key can be added to the R environment file and called for later use, see the examples.
+#' This function uses rainfall and streamflow data from NOAA and USGS and requires an API key.  See the webpage <https://www.ncdc.noaa.gov/cdo-web/token> for retrieving a NOAA token.  This key can be added to the R environment file and called for later use, see the examples.
 #'
 #' These estimates are used in annual compliance assessment reports produced by the Tampa Bay Nitrogen Management Consortium. Load estimates and adjustment factors are based on regression models in https://drive.google.com/file/d/11NT0NQ2WbPO6pVZaD7P7Z6qjcwO1jxHw/view?usp=drivesdk
 #'
 #' @concept analyze
 #'
-#' @importFrom rnoaa ncdc
-#'
 #' @return A data frame with hydrological load estimates by bay segments for the requested years
 #' @export
 #'
@@ -36,9 +34,6 @@
 #' }
 anlz_hydroload <- function(yrs, noaa_key = NULL, trace = FALSE){
 
-  if(!requireNamespace('rnoaa', quietly = TRUE))
-    stop("Package \"noaa\" needed for this function to work. Please install it.", call. = FALSE)
-
   res <- yrs %>%
     tibble::enframe('name', 'year') %>%
     dplyr::group_by(name) %>%
@@ -55,17 +50,10 @@ anlz_hydroload <- function(yrs, noaa_key = NULL, trace = FALSE){
         end <- paste0(yr, "-12-31")
 
         # download NOAA UWS rainfall station data
-        sp_rainfall <- ncdc(datasetid = "GHCND", stationid = "GHCND:USW00092806",
-                            datatypeid = "PRCP", startdate = start, enddate = end,
-                            limit = 500, add_units = TRUE, token = noaa_key)
-        sp_rain <- sp_rainfall$data %>%
-          dplyr::summarise(sum = sum(value)/254)
-
-        tia_rainfall <- ncdc(datasetid = "GHCND", stationid = "GHCND:USW00012842",
-                             datatypeid = "PRCP", startdate = start, enddate = end,
-                             limit = 500, add_units = TRUE, token = noaa_key)
-        tia_rain <- tia_rainfall$data %>%
-          dplyr::summarise(sum = sum(value)/254)
+        sp_rain <- util_rain(station = 'GHCND:USW00092806', start = start, end = end,
+                            token = noaa_key, quiet = T)
+        tia_rain <- util_rain(station = 'GHCND:USW00012842', start = start, end = end,
+                            token = noaa_key, quiet = T)
 
         # download USGS streamflow data
         hr <- dataRetrieval::readNWISdv("02303000", "00060", start, end) %>%

R/util_rain.R

@@ -0,0 +1,118 @@
+#' Get rainfall data at NOAA NCDC sites
+#'
+#' Get rainfall data at NOAA NCDC sites
+#'
+#' @param station character for the station id to retrieve
+#' @param start character for start of time period as YYYY-MM-DD
+#' @param end character for end of time period as YYYY-MM-DD
+#' @param token character for the NOAA API key
+#' @param ntry numeric for the number of times to try to download the data
+#' @param quiet logical to print progress in the console
+#'
+#' @details This function is used to retrieve a long-term record of rainfall for the requested station.  A NOAA API key is required to use the function.
+#'
+#' @return a single value data frame with the rainfall sum in inches
+#'
+#' @export
+#'
+#' @seealso \code{\link{anlz_hydroload}}
+#'
+#' @examples
+#' \dontrun{
+#' noaa_key <- Sys.getenv('NOAA_KEY')
+#' util_rain('GHCND:USW00092806', start = '2021-01-01', end = '2021-12-31', noaa_key)
+#' }
+util_rain <- function(station = NULL, start, end, token, ntry = 5, quiet = FALSE){
+
+  # empty data frame
+  empt <- data.frame(
+          sum = NA_real_
+  )
+  
+  # Build the API request URL
+  base_url <- "https://www.ncei.noaa.gov/cdo-web/api/v2/data"
+  query_params <- list(
+    datasetid = 'GHCND',
+    stationid = station,
+    datatypeid = 'PRCP',
+    startdate = start,
+    enddate = end,
+    limit = 1000,  # Increased from 400 to get more data per request
+    units = 'metric'
+  )
+  
+  # Make the API request
+  dat <- try({
+    response <- httr::GET(
+      url = base_url,
+      query = query_params,
+      httr::add_headers(token = token)
+    )
+    
+    # Check if request was successful
+    if(httr::status_code(response) != 200) {
+      stop("API request failed with status code: ", httr::status_code(response))
+    }
+    
+    # Parse the JSON response
+    content <- httr::content(response, as = "text", encoding = "UTF-8")
+    parsed_data <- jsonlite::fromJSON(content)
+    
+    # Return the results data frame
+    if(!length(parsed_data$results) == 0) {
+      parsed_data$results
+    } else {
+      empt
+    }
+    
+  }, silent = TRUE)
+
+  tryi <- 0
+  while(inherits(dat, 'try-error') & tryi < ntry) {
+
+    if(!quiet)
+      cat('Retrying...\n')
+
+    dat <- try({
+      response <- httr::GET(
+        url = base_url,
+        query = query_params,
+        httr::add_headers(token = token)
+      )
+      
+      if(httr::status_code(response) != 200) {
+        stop("API request failed with status code: ", httr::status_code(response))
+      }
+      
+      content <- httr::content(response, as = "text", encoding = "UTF-8")
+      parsed_data <- jsonlite::fromJSON(content)
+
+      if(!length(parsed_data$results) == 0) {
+        parsed_data$results
+      } else {
+        empt
+      }
+      
+    }, silent = TRUE)
+    
+    tryi <- tryi + 1
+  }
+
+  if(tryi == ntry){
+    if(!quiet) cat('Failed...\n')
+    stop()
+  }
+
+  # Return empty data frame with expected structure if no data
+  if(nrow(dat) == 0)
+    return(empt)
+
+  # convert mm to inches, sum across time period, 
+  out <- dat |>
+    dplyr::mutate(
+      value = value / 25.4
+    ) |>
+    dplyr::summarise(sum = sum(value, na.rm = TRUE))
+
+  return(out)
+}