Skip to content
Snippets Groups Projects
Commit 2374fd65 authored by Laura A DeCicco's avatar Laura A DeCicco
Browse files

Add some documentation

parent a4a3e0a2
No related branches found
No related tags found
No related merge requests found
Pipeline #512254 failed
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 = "ldecicco@usgs.gov",
......
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.
......
#' 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
......
......@@ -16,7 +16,8 @@ raw data from web services
}
\description{
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
}
\examples{
\dontshow{if (is_dataRetrieval_user()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment