Skip to content
Snippets Groups Projects
importRDB1.Rd 2.59 KiB
Newer Older
% Generated by roxygen2 (4.0.2): do not edit by hand
Laura A DeCicco's avatar
Laura A DeCicco committed
\name{importRDB1}
\alias{importRDB1}
Laura A DeCicco's avatar
Laura A DeCicco committed
\title{Function to return data from the NWIS RDB 1.0 format}
\usage{
importRDB1(obs_url, asDateTime = FALSE, qw = FALSE, convertType = TRUE,
  tz = "")
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\arguments{
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{obs_url}{string containing the url for the retrieval}
Laura A DeCicco's avatar
Laura A DeCicco committed
\item{asDateTime}{logical, if TRUE returns date and time as POSIXct, if FALSE, Date}
Laura A DeCicco's avatar
Laura A DeCicco committed

\item{qw}{logical, if TRUE parses as water quality data (where dates/times are in start and end times)}

\item{convertType}{logical, defaults to TRUE. If TRUE, the function will convert the data to dates, datetimes,
numerics based on a standard algorithm. If false, everything is returned as a string.}

\item{tz}{string to set timezone attribute of datetime. Default is an empty quote, which converts the
datetimes to UTC (properly accounting for daylight savings times based on the data's provided tz_cd column).
Possible values to provide are "America/New_York","America/Chicago", "America/Denver","America/Los_Angeles",
"America/Anchorage","America/Honolulu","America/Jamaica","America/Managua","America/Phoenix", and "America/Metlakatla"}
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\value{
data a data frame containing columns agency, site, dateTime (converted to UTC), values, and remark codes for all requested combinations
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\description{
Laura A DeCicco's avatar
Laura A DeCicco committed
This function accepts a url parameter that already contains the desired
Laura A DeCicco's avatar
Laura A DeCicco committed
NWIS site, parameter code, statistic, startdate and enddate. It is not
recommended to use the RDB format for importing multi-site data.
Laura A DeCicco's avatar
Laura A DeCicco committed
}
\examples{
siteNumber <- "02177000"
Laura A DeCicco's avatar
Laura A DeCicco committed
startDate <- "2012-09-01"
endDate <- "2012-10-01"
obs_url <- constructNWISURL(siteNumber,property,
Laura A DeCicco's avatar
Laura A DeCicco committed
data <- importRDB1(obs_url)
Laura A DeCicco's avatar
Laura A DeCicco committed
urlMultiPcodes <- constructNWISURL("04085427",c("00060","00010"),
         startDate,endDate,"dv",statCd=c("00003","00001"),"tsv")
Laura A DeCicco's avatar
Laura A DeCicco committed
multiData <- importRDB1(urlMultiPcodes)
unitDataURL <- constructNWISURL(siteNumber,property,
         "2013-11-03","2013-11-03","uv",format="tsv") #includes timezone switch
Laura A DeCicco's avatar
Laura A DeCicco committed
unitData <- importRDB1(unitDataURL, asDateTime=TRUE)
qwURL <- constructNWISURL(c('04024430','04024000'),
          c('34247','30234','32104','34220'),
         "2010-11-03","","qw",format="rdb")
qwData <- importRDB1(qwURL, qw=TRUE, tz="America/Chicago")
Laura A DeCicco's avatar
Laura A DeCicco committed
iceSite <- '04024430'
start <- "2013-11-09"
end <- "2013-11-28"
urlIce <- constructNWISURL(iceSite,"00060",start, end,"uv",format="tsv")

Laura A DeCicco's avatar
Laura A DeCicco committed
filePath <- system.file("extdata", package="dataRetrieval")
fileName <- "RDB1Example.txt"
fullPath <- file.path(filePath, fileName)
importUserRDB <- importRDB1(fullPath)