Skip to content
Snippets Groups Projects
readNWISdv.Rd 2.37 KiB
Newer Older
% Generated by roxygen2 (4.0.2): do not edit by hand
Laura A DeCicco's avatar
Laura A DeCicco committed
\name{readNWISdv}
\alias{readNWISdv}
\title{Raw Data Import for USGS NWIS Data}
Laura A DeCicco's avatar
Laura A DeCicco committed
\usage{
Laura A DeCicco's avatar
Laura A DeCicco committed
readNWISdv(siteNumber, parameterCd, startDate, endDate, statCd = "00003",
  format = "tsv")
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\arguments{
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{siteNumber}{string USGS site number.  This is usually an 8 digit number. Multiple sites can be requested with a string vector.}
Laura A DeCicco's avatar
Laura A DeCicco committed

\item{parameterCd}{string or vector of 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{statCd}{string USGS statistic code. This is usually 5 digits.  Daily mean (00003) is the default.}
Laura A DeCicco's avatar
Laura A DeCicco committed

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 'tsv'.}
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\value{
Laura A DeCicco's avatar
Laura A DeCicco committed
data dataframe with agency, site, dateTime, value, and code columns
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\description{
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://help.waterdata.usgs.gov/codes-and-parameters/parameters}
A list of statistic codes can be found here: \url{http://help.waterdata.usgs.gov/code/stat_code_query?fmt=html}
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\examples{
siteNumber <- '04085427'
startDate <- '2012-01-01'
endDate <- '2012-06-30'
Laura A DeCicco's avatar
Laura A DeCicco committed
rawDailyQ <- readNWISdv(siteNumber,pCode, startDate, endDate)
rawDailyTemperature <- readNWISdv(siteNumber,'00010',
       startDate, endDate, statCd='00001')
Laura A DeCicco's avatar
Laura A DeCicco committed
rawDailyTemperatureTSV <- readNWISdv(siteNumber,'00010',
       startDate, endDate, statCd='00001',format='tsv')
Laura A DeCicco's avatar
Laura A DeCicco committed
rawDailyQAndTempMeanMax <- readNWISdv(siteNumber,c('00010','00060'),
       startDate, endDate, statCd=c('00001','00003'))
Laura A DeCicco's avatar
Laura A DeCicco committed
rawDailyMultiSites<- readNWISdv(c("01491000","01645000"),c('00010','00060'),
Laura A DeCicco's avatar
Laura A DeCicco committed
       startDate, endDate, statCd=c('00001','00003'))
Laura A DeCicco's avatar
Laura A DeCicco committed
}
Laura A DeCicco's avatar
Laura A DeCicco committed
\keyword{data}
\keyword{import}
\keyword{service}
\keyword{web}