Add some documentation

DOI-USGS · Nov 5, 2024 · 2374fd6 · 2374fd6
1 parent a4a3e0a
commit 2374fd6
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: dataRetrieval
 Type: Package
 Title: Retrieval Functions for USGS and EPA Hydrology and Water Quality Data
-Version: 2.7.17
+Version: 2.7.17.9000
 Authors@R: c(
     person("Laura", "DeCicco", role = c("aut","cre"),
             email = "[email protected]",

diff --git a/NEWS b/NEWS
@@ -1,3 +1,7 @@
+dataRetrieval 2.7.18
+===================
+* Added a way to include a custom user-agent suffix via an enviornmental variable "CUSTOM_DR_UA"
+
 dataRetrieval 2.7.17
 ===================
 * Fixed bug with server problems causing errors.

diff --git a/R/getWebServiceData.R b/R/getWebServiceData.R
@@ -1,7 +1,8 @@
 #' Function to return data from web services
 #'
 #' This function accepts a url parameter, and returns the raw data. The function enhances
-#' \code{\link[httr]{GET}} with more informative error messages.
+#' \code{\link[httr]{GET}} with more informative error messages. To add a 
+#' custom user agent, create an environmental variable: CUSTOM_DR_UA
 #'
 #' @param obs_url character containing the url for the retrieval
 #' @param \dots information to pass to header request

diff --git a/man/getWebServiceData.Rd b/man/getWebServiceData.Rd