From 8255cce34eb468dff52a38ddf3f2c0cae27d91ae Mon Sep 17 00:00:00 2001
From: unknown <ldecicco@usgs.gov>
Date: Thu, 11 Sep 2014 10:49:50 -0500
Subject: [PATCH] Automated help file builds.
---
man/compressData.Rd | 4 +++-
man/constructNWISURL.Rd | 12 ++++++++----
man/formatCheckSiteNumber.Rd | 2 --
man/getDataFromFile.Rd | 2 +-
man/getRDB1Data.Rd | 11 ++++++++---
man/getWaterML1Data.Rd | 13 +++++++++----
man/renameColumns.Rd | 3 ++-
man/retrieveNWISdvData.Rd | 9 ++++++---
man/retrieveWQPqwData.Rd | 2 +-
9 files changed, 38 insertions(+), 20 deletions(-)
diff --git a/man/compressData.Rd b/man/compressData.Rd
index 44841780..5782f8d5 100644
--- a/man/compressData.Rd
+++ b/man/compressData.Rd
@@ -28,7 +28,9 @@ comment2 <- c("","<","")
value2 <- c(2,3,4)
comment3 <- c("","","<")
value3 <- c(3,4,5)
-dataInput <- data.frame(dateTime, comment1, value1, comment2, value2, comment3, value3, stringsAsFactors=FALSE)
+dataInput <- data.frame(dateTime, comment1, value1,
+ comment2, value2,
+ comment3, value3, stringsAsFactors=FALSE)
compressData(dataInput)
}
\keyword{WRTDS}
diff --git a/man/constructNWISURL.Rd b/man/constructNWISURL.Rd
index c0386ebd..bc503ef2 100644
--- a/man/constructNWISURL.Rd
+++ b/man/constructNWISURL.Rd
@@ -41,12 +41,16 @@ siteNumber <- '01594440'
startDate <- '1985-01-01'
endDate <- ''
pCode <- c("00060","00010")
-url_daily <- constructNWISURL(siteNumber,pCode,startDate,endDate,'dv',statCd=c("00003","00001"))
+url_daily <- constructNWISURL(siteNumber,pCode,
+ startDate,endDate,'dv',statCd=c("00003","00001"))
url_unit <- constructNWISURL(siteNumber,pCode,"2012-06-28","2012-06-30",'iv')
url_qw_single <- constructNWISURL(siteNumber,"01075",startDate,endDate,'qw')
-url_qw <- constructNWISURL(siteNumber,c('01075','00029','00453'),startDate,endDate,'qw')
-url_wqp <- constructNWISURL(paste("USGS",siteNumber,sep="-"),c('01075','00029','00453'),startDate,endDate,'wqp')
-url_daily_tsv <- constructNWISURL(siteNumber,pCode,startDate,endDate,'dv',statCd=c("00003","00001"),format="tsv")
+url_qw <- constructNWISURL(siteNumber,c('01075','00029','00453'),
+ startDate,endDate,'qw')
+url_wqp <- constructNWISURL(paste("USGS",siteNumber,sep="-"),c('01075','00029','00453'),
+ startDate,endDate,'wqp')
+url_daily_tsv <- constructNWISURL(siteNumber,pCode,startDate,endDate,'dv',
+ statCd=c("00003","00001"),format="tsv")
}
\keyword{USGS}
\keyword{data}
diff --git a/man/formatCheckSiteNumber.Rd b/man/formatCheckSiteNumber.Rd
index 744cddc0..120e99d0 100644
--- a/man/formatCheckSiteNumber.Rd
+++ b/man/formatCheckSiteNumber.Rd
@@ -19,8 +19,6 @@ Checks that the site code is at least 8 digits. If not, it confirms with the use
\examples{
site<- '01234567'
formatCheckSiteNumber(site)
-site_incorrect <- '1234567'
-formatCheckSiteNumber(site_incorrect)
}
\keyword{WRTDS}
\keyword{flow}
diff --git a/man/getDataFromFile.Rd b/man/getDataFromFile.Rd
index ae4d4fe5..a138b286 100644
--- a/man/getDataFromFile.Rd
+++ b/man/getDataFromFile.Rd
@@ -28,7 +28,7 @@ The third column is optional, it contains any remark codes.
filePath <- system.file("extdata", package="dataRetrieval")
filePath <- paste(filePath,"/",sep="")
fileName <- 'ChoptankRiverFlow.txt'
-getDataFromFile(filePath,fileName, separator="\\t")
+ChopData <- getDataFromFile(filePath,fileName, separator="\\t")
}
\keyword{data}
\keyword{file}
diff --git a/man/getRDB1Data.Rd b/man/getRDB1Data.Rd
index b4b48d29..4ce65b14 100644
--- a/man/getRDB1Data.Rd
+++ b/man/getRDB1Data.Rd
@@ -18,14 +18,19 @@ This function accepts a url parameter that already contains the desired
NWIS site, parameter code, statistic, startdate and enddate.
}
\examples{
-sites <- "02177000"
+siteNumber <- "02177000"
startDate <- "2012-09-01"
endDate <- "2012-10-01"
offering <- '00003'
property <- '00060'
-obs_url <- constructNWISURL(sites,property,startDate,endDate,'dv',format='tsv')
+obs_url <- constructNWISURL(siteNumber,property,
+ startDate,endDate,'dv',format='tsv')
data <- getRDB1Data(obs_url)
-urlMulti <- constructNWISURL("04085427",c("00060","00010"),startDate,endDate,'dv',statCd=c("00003","00001"),'tsv')
+urlMulti <- constructNWISURL("04085427",c("00060","00010"),
+ startDate,endDate,'dv',statCd=c("00003","00001"),'tsv')
multiData <- getRDB1Data(urlMulti)
+unitDataURL <- constructNWISURL(siteNumber,property,
+ as.character(Sys.Date()),as.character(Sys.Date()),'uv',format='tsv')
+unitData <- getRDB1Data(unitDataURL, asDateT=TRUE)
}
diff --git a/man/getWaterML1Data.Rd b/man/getWaterML1Data.Rd
index a0a07f0f..575e4457 100644
--- a/man/getWaterML1Data.Rd
+++ b/man/getWaterML1Data.Rd
@@ -16,16 +16,21 @@ This function accepts a url parameter that already contains the desired
NWIS site, parameter code, statistic, startdate and enddate.
}
\examples{
-sites <- "02177000"
+siteNumber <- "02177000"
startDate <- "2012-09-01"
endDate <- "2012-10-01"
offering <- '00003'
property <- '00060'
-obs_url <- constructNWISURL(sites,property,startDate,endDate,'dv')
+obs_url <- constructNWISURL(siteNumber,property,startDate,endDate,'dv')
data <- getWaterML1Data(obs_url)
-urlMulti <- constructNWISURL("04085427",c("00060","00010"),startDate,endDate,'dv',statCd=c("00003","00001"))
+urlMulti <- constructNWISURL("04085427",c("00060","00010"),
+ startDate,endDate,'dv',statCd=c("00003","00001"))
multiData <- getWaterML1Data(urlMulti)
-goundwaterExampleURL <- "http://waterservices.usgs.gov/nwis/gwlevels/?format=waterml&sites=431049071324301&startDT=2013-10-01&endDT=2014-06-30"
+goundwaterExampleURL <-
+ "http://waterservices.usgs.gov/nwis/gwlevels/?format=waterml&sites=431049071324301&startDT=2013-10-01&endDT=2014-06-30"
groundWater <- getWaterML1Data(goundwaterExampleURL)
+unitDataURL <- constructNWISURL(siteNumber,property,
+ as.character(Sys.Date()),as.character(Sys.Date()),'uv',format='xml')
+unitData <- getWaterML1Data(unitDataURL)
}
diff --git a/man/renameColumns.Rd b/man/renameColumns.Rd
index 6442b41c..fc26c62c 100644
--- a/man/renameColumns.Rd
+++ b/man/renameColumns.Rd
@@ -17,7 +17,8 @@ Rename columns coming back from NWIS data retrievals
\examples{
# This example requires an internet connection to run
siteNumber <- '05114000'
-rawData <- retrieveNWISdvData(siteNumber,c("00010","00060","00300"),"2001-01-01","2002-01-01",statCd=c("00001","00003"))
+rawData <- retrieveNWISdvData(siteNumber,c("00010","00060","00300"),
+ "2001-01-01","2002-01-01",statCd=c("00001","00003"))
rawData <- renameColumns(rawData)
today <- as.character(Sys.Date())
rawData2 <- retrieveNWISunitData(siteNumber,c("00010","00060"),today,today)
diff --git a/man/retrieveNWISdvData.Rd b/man/retrieveNWISdvData.Rd
index dc0516c8..72badd54 100644
--- a/man/retrieveNWISdvData.Rd
+++ b/man/retrieveNWISdvData.Rd
@@ -38,9 +38,12 @@ startDate <- '2012-01-01'
endDate <- '2012-06-30'
pCode <- '00060'
rawDailyQ <- retrieveNWISdvData(siteNumber,pCode, startDate, endDate)
-rawDailyTemperature <- retrieveNWISdvData(siteNumber,'00010', startDate, endDate, statCd='00001')
-rawDailyTemperatureTSV <- retrieveNWISdvData(siteNumber,'00010', startDate, endDate, statCd='00001',format='tsv')
-rawDailyQAndTempMeanMax <- retrieveNWISdvData(siteNumber,c('00010','00060'), startDate, endDate, statCd=c('00001','00003'))
+rawDailyTemperature <- retrieveNWISdvData(siteNumber,'00010',
+ startDate, endDate, statCd='00001')
+rawDailyTemperatureTSV <- retrieveNWISdvData(siteNumber,'00010',
+ startDate, endDate, statCd='00001',format='tsv')
+rawDailyQAndTempMeanMax <- retrieveNWISdvData(siteNumber,c('00010','00060'),
+ startDate, endDate, statCd=c('00001','00003'))
}
\keyword{USGS}
\keyword{data}
diff --git a/man/retrieveWQPqwData.Rd b/man/retrieveWQPqwData.Rd
index 50677300..79b0c0ce 100644
--- a/man/retrieveWQPqwData.Rd
+++ b/man/retrieveWQPqwData.Rd
@@ -9,7 +9,7 @@ retrieveWQPqwData(siteNumber, parameterCd, startDate, endDate,
\arguments{
\item{siteNumber}{string USGS site number. This is usually an 8 digit number}
-\item{parameterCd}{vector of USGS 5-digit parameter code. Leaving this blank will return all of the measured values during the specified time period.}
+\item{parameterCd}{vector of USGS 5-digit parameter code or string of characteristicNames. Leaving this blank will return all of the measured values during the specified time period.}
\item{startDate}{string starting date for data retrieval in the form YYYY-MM-DD.}
--
GitLab