-
Laura A DeCicco authoredLaura A DeCicco authored
retrieveUnitNWISData.Rd 2.14 KiB
\name{retrieveUnitNWISData}
\alias{retrieveUnitNWISData}
\title{Raw Data Import for Instantaneous USGS NWIS Data}
\usage{
retrieveUnitNWISData(siteNumber, ParameterCd, StartDate,
EndDate, format = "xml", interactive = TRUE)
}
\arguments{
\item{siteNumber}{string USGS site number. This is
usually an 8 digit number}
\item{ParameterCd}{string USGS parameter code. This is
usually an 5 digit number.}
\item{StartDate}{string starting date for data retrieval
in the form YYYY-MM-DD.}
\item{EndDate}{string ending date for data retrieval in
the form YYYY-MM-DD.}
\item{interactive}{logical Option for interactive mode.
If true, there is user interaction for error handling and
data checks.}
\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".}
}
\value{
data dataframe with agency, site, dateTime, time zone,
value, and code columns
}
\description{
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 <- retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE)
rawData2 <- retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,"tsv",interactive=FALSE)
}
\keyword{USGS}
\keyword{data}
\keyword{import}
\keyword{service}
\keyword{web}