diff --git a/inst/doc/dataRetrieval.R b/inst/doc/dataRetrieval.R index 1eb78388f37fbefb4a1c8a54a9805ab7233be7f5..93d31e60ea5a89710b478137fb032a85f273b896 100644 --- a/inst/doc/dataRetrieval.R +++ b/inst/doc/dataRetrieval.R @@ -155,7 +155,7 @@ temperatureAndFlow <- readNWISdv(siteNumber, parameterCd, ## ----label=renameColumns, echo=TRUE----------------------- names(temperatureAndFlow) -temperatureAndFlow <- renameColumns(temperatureAndFlow) +temperatureAndFlow <- renameNWISColumns(temperatureAndFlow) names(temperatureAndFlow) ## ----getNWIStemperaturePlot, echo=TRUE, fig.cap="Temperature and discharge plot of Choptank River in 2012.",out.width='1\\linewidth',out.height='1\\linewidth',fig.show='hold'---- diff --git a/inst/doc/dataRetrieval.Rnw b/inst/doc/dataRetrieval.Rnw index 559db31e30cc7bd8994897b5d9ab02484772eeb8..8dea3c455e9864b7aaf3b5be60b7ceaf0881fad8 100644 --- a/inst/doc/dataRetrieval.Rnw +++ b/inst/doc/dataRetrieval.Rnw @@ -472,12 +472,12 @@ temperatureAndFlow <- readNWISdv(siteNumber, parameterCd, Daily data is pulled from \url{http://waterservices.usgs.gov/rest/DV-Test-Tool.html}. -The column names can be automatically adjusted based on the parameter and statistic codes using the \texttt{renameColumns} function. This is not necessary, but may be useful when analyzing the data. +The column names can be automatically adjusted based on the parameter and statistic codes using the \texttt{renameNWISColumns} function. This is not necessary, but may be useful when analyzing the data. <<label=renameColumns, echo=TRUE>>= names(temperatureAndFlow) -temperatureAndFlow <- renameColumns(temperatureAndFlow) +temperatureAndFlow <- renameNWISColumns(temperatureAndFlow) names(temperatureAndFlow) @ diff --git a/inst/doc/dataRetrieval.pdf b/inst/doc/dataRetrieval.pdf index e9d3db2a04bf4733066be9b610521213eeb957dc..c9af79fee51cf7b0de046e44b28bb97353c626ef 100644 Binary files a/inst/doc/dataRetrieval.pdf and b/inst/doc/dataRetrieval.pdf differ diff --git a/man/readNWISgwl.Rd b/man/readNWISgwl.Rd index 8648389458c339697a669e4139b260f374d0272d..4ee53c4e5296deccbc1c2f07365725c32ce8c0f6 100644 --- a/man/readNWISgwl.Rd +++ b/man/readNWISgwl.Rd @@ -3,10 +3,10 @@ \alias{readNWISgwl} \title{Reads groundwater level measurements from NWISweb.} \usage{ -readNWISgwl(siteNumber, startDate = "", endDate = "") +readNWISgwl(siteNumbers, startDate = "", endDate = "") } \arguments{ -\item{siteNumber}{string USGS site number. This is usually an 8 digit number} +\item{siteNumbers}{string USGS site number (or multiple sites). This is usually an 8 digit number} \item{startDate}{string starting date for data retrieval in the form YYYY-MM-DD.} @@ -19,5 +19,7 @@ depending on the year that the data was collected. \examples{ siteNumber <- "434400121275801" data <- readNWISgwl(siteNumber, '','') +sites <- c("434400121275801", "375907091432201") +data2 <- readNWISgwl(sites, '','') } diff --git a/man/readNWISuv.Rd b/man/readNWISuv.Rd index 9dbc2bef58b61094775dc2661926811919ed106e..de806e3af5acadbf75b2fd2fe7cdfa0063f80483 100644 --- a/man/readNWISuv.Rd +++ b/man/readNWISuv.Rd @@ -3,10 +3,11 @@ \alias{readNWISuv} \title{Raw Data Import for Instantaneous USGS NWIS Data} \usage{ -readNWISuv(siteNumber, parameterCd, startDate = "", endDate = "", tz = "") +readNWISuv(siteNumbers, parameterCd, startDate = "", endDate = "", + tz = "") } \arguments{ -\item{siteNumber}{string USGS site number. This is usually an 8 digit number} +\item{siteNumbers}{string USGS site number (or multiple sites). This is usually an 8 digit number} \item{parameterCd}{string USGS parameter code. This is usually an 5 digit number.} diff --git a/man/renameColumns.Rd b/man/renameColumns.Rd deleted file mode 100644 index c8ca1e9dd7c489e7b407999e8d19b31bd5a22b7f..0000000000000000000000000000000000000000 --- a/man/renameColumns.Rd +++ /dev/null @@ -1,32 +0,0 @@ -% Generated by roxygen2 (4.0.2): do not edit by hand -\name{renameColumns} -\alias{renameColumns} -\title{renameColumns} -\usage{ -renameColumns(rawData, p00010 = "Wtemp", p00045 = "Precip", - p00060 = "Flow", p00065 = "GH", p00095 = "SpecCond", p00300 = "DO", - p00400 = "pH", p62611 = "GWL", p63680 = "Turb", p72019 = "WLBLS", ...) -} -\arguments{ -\item{rawData}{dataframe returned from retrieval functions} -} -\value{ -rawData dataframe with improved column names -} -\description{ -Rename columns coming back from NWIS data retrievals -} -\examples{ -siteWithTwo <- '01480015' -startDate <- "2012-09-01" -endDate <- "2012-10-01" -url2 <- constructNWISURL(siteWithTwo, "00060",startDate,endDate,'dv') -twoResults <- importWaterML1(url2,TRUE) -twoResults <- renameColumns(twoResults) -} -\keyword{USGS} -\keyword{data} -\keyword{import} -\keyword{service} -\keyword{web} - diff --git a/man/renameNWISColumns.Rd b/man/renameNWISColumns.Rd new file mode 100644 index 0000000000000000000000000000000000000000..e594b37039c3e97763f1d9bc959387eddd4e56c6 --- /dev/null +++ b/man/renameNWISColumns.Rd @@ -0,0 +1,76 @@ +% Generated by roxygen2 (4.0.2): do not edit by hand +\name{renameNWISColumns} +\alias{renameNWISColumns} +\title{renameColumns} +\usage{ +renameNWISColumns(rawData, p00010 = "Wtemp", p00045 = "Precip", + p00060 = "Flow", p00065 = "GH", p00095 = "SpecCond", p00300 = "DO", + p00400 = "pH", p62611 = "GWL", p63680 = "Turb", p72019 = "WLBLS", ...) +} +\arguments{ +\item{rawData}{the daily- or unit-values datset retrieved from NWISweb.} + +\item{p00010}{the base name for parameter code 00010.} + +\item{p00045}{the base name for parameter code 00045.} + +\item{p00060}{the base name for parameter code 00060.} + +\item{p00065}{the base name for parameter code 00065.} + +\item{p00095}{the base name for parameter code 00095.} + +\item{p00300}{the base name for parameter code 00300.} + +\item{p00400}{the base name for parameter code 00400.} + +\item{p62611}{the base name for parameter code 62611.} + +\item{p63680}{the base name for parameter code 63680.} + +\item{p72019}{the base name for parameter code 72019.} + +\item{\dots}{named arguments for the base name for any other parameter code. The +form of the name must be like pXXXXX, where XXXXX is the parameter code.} +} +\value{ +A dataset like \code{data} with selected columns renamed. +} +\description{ +Rename columns coming back from NWIS data retrievals. Daily and unit value columns +have names derived from their data descriptor, parameter, and statistic codes. This +function reads information from the header and the arguments in the call to +to rename those columns. +} +\note{ +The following statistics codes are converted by \code{renameNWISColumns}. See +\url{http://help.waterdata.usgs.gov/stat_cd_nm} for information about USGS statistics codes. +\describe{ +\item{00001}{Maximum value, suffix: Max} +\item{00002}{Minimum value, suffix: Min} +\item{00003}{Mean value, no suffix} +\item{00006}{Sum of values, suffix: Sum} +\item{00007}{Modal value, suffix: Mode} +\item{00008}{Median value, suffix: Median} +\item{00011}{Instantaneous Value, suffix: Inst} +\item{00012}{Equivalent mean value, suffix: EqMean} +\item{00021}{Tidal high-high value, suffix: HiHiTide} +\item{00022}{Tidal low-high value, suffix: LoHiTide} +\item{00023}{Tidal high-low value, suffix: HiLoTide} +\item{00024}{Tidal low-low value, suffix: LoLoTide} +} +} +\examples{ +siteWithTwo <- '01480015' +startDate <- "2012-09-01" +endDate <- "2012-10-01" +url2 <- constructNWISURL(siteWithTwo, "00060",startDate,endDate,'dv') +twoResults <- importWaterML1(url2,TRUE) +twoResults <- renameNWISColumns(twoResults) +} +\seealso{ +\code{\link{readNWISdv}}, \code{\link{readNWISuv}} +} +\keyword{IO} +\keyword{manip} + diff --git a/vignettes/dataRetrieval-concordance.tex b/vignettes/dataRetrieval-concordance.tex new file mode 100644 index 0000000000000000000000000000000000000000..6719a33a9b0bb59834d944ce07f4db9fc61a80a7 --- /dev/null +++ b/vignettes/dataRetrieval-concordance.tex @@ -0,0 +1,7 @@ +\Sconcordance{concordance:dataRetrieval.tex:dataRetrieval.Rnw:% +1 127 1 49 0 1 7 15 1 1 14 45 1 3 0 93 1 2 0 8 1 9 0 % +24 1 3 0 21 1 4 0 6 1 8 0 18 1 3 0 25 1 1 4 19 1 9 0 % +6 1 7 0 23 1 7 0 16 1 2 0 11 1 15 0 22 1 9 0 20 1 3 0 % +6 1 20 0 30 1 38 0 10 1 9 0 40 1 4 0 14 1 4 0 33 1 13 % +0 39 1 14 0 18 1 2 0 14 1 2 0 24 1 4 0 9 1 14 0 13 1 % +4 0 14 1 4 0 5 1 4 0 22 1 18 0 8 1 4 0 43 1}