Skip to content
Snippets Groups Projects
retrieveNWISunitData.Rd 2.1 KiB
Newer Older
Laura A DeCicco's avatar
Laura A DeCicco committed
% Generated by roxygen2 (4.0.1): do not edit by hand
\name{retrieveNWISunitData}
\alias{retrieveNWISunitData}
\title{Raw Data Import for Instantaneous USGS NWIS Data}
retrieveNWISunitData(siteNumber, ParameterCd, StartDate, EndDate,
Laura A DeCicco's avatar
Laura A DeCicco committed
  format = "xml", interactive = TRUE)
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{siteNumber}{string USGS site number.  This is usually an 8 digit number}
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{ParameterCd}{string USGS parameter code.  This is usually an 5 digit number.}
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{StartDate}{string starting date for data retrieval in the form YYYY-MM-DD.}
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{EndDate}{string ending date for data retrieval in the form YYYY-MM-DD.}
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{interactive}{logical Option for interactive mode.  If true, there is user interaction for error handling and data checks.}
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{format}{string, can be "tsv" or "xml", and is only applicable for daily and unit value requests.  "tsv" returns results faster, but there is a possiblitiy that an incomplete file is returned without warning. XML is slower,
but will offer a warning if the file was incomplete (for example, if there was a momentary problem with the internet connection). It is possible to safely use the "tsv" option,
but the user must carefully check the results to see if the data returns matches what is expected. The default is therefore "xml".}
Laura A DeCicco's avatar
Laura A DeCicco committed
data dataframe with agency, site, dateTime, time zone, value, and code columns
Laura A DeCicco's avatar
Laura A DeCicco committed
Imports data from NWIS web service. This function gets the data from here: \url{http://waterservices.usgs.gov/}
A list of parameter codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/pmcodes/}
A list of statistic codes can be found here: \url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table}
}
\examples{
siteNumber <- '05114000'
ParameterCd <- '00060'
StartDate <- as.character(Sys.Date())
EndDate <- as.character(Sys.Date())
# These examples require an internet connection to run
rawData <- retrieveNWISunitData(siteNumber,ParameterCd,StartDate,EndDate)
rawData2 <- retrieveNWISunitData(siteNumber,ParameterCd,StartDate,EndDate,"tsv")
\keyword{data}
\keyword{import}
\keyword{service}
\keyword{web}