Skip to content
Snippets Groups Projects
readNWISdv.Rd 3.29 KiB
Newer Older
  • Learn to ignore specific revisions
  • % Generated by roxygen2 (4.0.2): do not edit by hand
    
    \name{getNWISdvData}
    \alias{getNWISdvData}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \alias{readNWISdv}
    
    \title{Raw Data Import for USGS NWIS Data}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \usage{
    
    getNWISdvData(siteNumber, parameterCd, startDate = "", endDate = "",
      statCd = "00003")
    
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    readNWISdv(siteNumber, parameterCd, startDate = "", endDate = "",
      statCd = "00003")
    
    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
    }
    \value{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    A data frame with the following columns:
    \tabular{lll}{
    Name \tab Type \tab Description \cr
    agency \tab character \tab The NWIS code for the agency reporting the data\cr
    site \tab character \tab The USGS site number \cr
    datetime \tab Date \tab The date of the value \cr
    tz_cd \tab character \tab The time zone code for datetime \cr
    code \tab character \tab Any codes that qualify the corresponding value\cr
    value \tab numeric \tab The numeric value for the parameter \cr
    }
    Note that code and value are repeated for the parameters requested. The names are of the form
    X_D_P_S, where X is literal,
    D is an option description of the parameter,
    P is the parameter code,
    and S is the statistic code (if applicable).
    
    There are also several useful attributes attached to the data frame:
    
    \tabular{lll}{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Name \tab Type \tab Description \cr
    url \tab character \tab The url used to generate the data \cr
    siteInfo \tab data.frame \tab A data frame containing information on the requested sites \cr
    variableInfo \tab data.frame \tab A data frame containing information on the requested parameters \cr
    statisticInfo \tab data.frame \tab A data frame containing information on the requested statistics on the data \cr
    queryTime \tab POSIXct \tab The time the data was returned \cr
    }
    
    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)
    rawDailyQAndTempMeanMax <- readNWISdv(siteNumber,c('00010','00060'),
    
           startDate, endDate, statCd=c('00001','00003'))
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    rawDailyQAndTempMeanMax <- renameNWISColumns(rawDailyQAndTempMeanMax)
    
    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
    # Site with no data:
    x <- readNWISdv("10258500","00060", "2014-09-08", "2014-09-14")
    names(attributes(x))
    attr(x, "siteInfo")
    attr(x, "variableInfo")
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    
    site <- "05212700"
    notActive <- readNWISdv(site, "00060", "2014-01-01","2014-01-07")
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \seealso{
    \code{\link{renameNWISColumns}}, \code{\link{importWaterML1}}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \keyword{data}
    \keyword{import}
    \keyword{service}
    \keyword{web}