From d9b5f474046fb4910b59bb59ebd9eec67ef078f8 Mon Sep 17 00:00:00 2001
From: unknown <ldecicco@usgs.gov>
Date: Wed, 28 Jan 2015 16:16:57 -0600
Subject: [PATCH] Updating help files.
---
man/importWaterML1.Rd | 13 +++++++------
man/importWaterML2.Rd | 9 ++++++++-
man/readNWISgwl.Rd | 2 ++
man/readNWISmeas.Rd | 2 ++
man/readNWISpeak.Rd | 2 ++
man/readNWISqw.Rd | 5 ++++-
man/readNWISrating.Rd | 2 ++
man/readNWISsite.Rd | 3 ++-
8 files changed, 29 insertions(+), 9 deletions(-)
diff --git a/man/importWaterML1.Rd b/man/importWaterML1.Rd
index 4d24fe37..7ab731bc 100644
--- a/man/importWaterML1.Rd
+++ b/man/importWaterML1.Rd
@@ -55,7 +55,7 @@ endDate <- "2012-10-01"
offering <- '00003'
property <- '00060'
obs_url <- constructNWISURL(siteNumber,property,startDate,endDate,'dv')
-
+\dontrun{
data <- importWaterML1(obs_url,TRUE)
groundWaterSite <- "431049071324301"
@@ -69,11 +69,6 @@ unitDataURL <- constructNWISURL(siteNumber,property,
"2013-11-03","2013-11-03",'uv')
unitData <- importWaterML1(unitDataURL,TRUE)
-filePath <- system.file("extdata", package="dataRetrieval")
-fileName <- "WaterML1Example.xml"
-fullPath <- file.path(filePath, fileName)
-importUserWM1 <- importWaterML1(fullPath,TRUE)
-
# Two sites, two pcodes, one site has two data descriptors:
siteNumber <- c('01480015',"04085427")
obs_url <- constructNWISURL(siteNumber,c("00060","00010"),startDate,endDate,'dv')
@@ -91,6 +86,12 @@ inactiveSite <- importWaterML1(inactiveSite)
inactiveAndAcitive <- c("07334200","05212700")
inactiveAndAcitive <- constructNWISURL(inactiveAndAcitive, "00060", "2014-01-01", "2014-01-10",'dv')
inactiveAndAcitive <- importWaterML1(inactiveAndAcitive)
+
+}
+filePath <- system.file("extdata", package="dataRetrieval")
+fileName <- "WaterML1Example.xml"
+fullPath <- file.path(filePath, fileName)
+imporFile <- importWaterML1(fullPath,TRUE)
}
\seealso{
\code{\link{renameNWISColumns}}
diff --git a/man/importWaterML2.Rd b/man/importWaterML2.Rd
index 52677dea..44d4c1e5 100644
--- a/man/importWaterML2.Rd
+++ b/man/importWaterML2.Rd
@@ -34,7 +34,7 @@ URL2 <- paste("http://cida.usgs.gov/noreast-sos/simple?request=GetObservation",
"featureID=MD-BC-BC-05",
"offering=RAW",
"observedProperty=WATER",sep="&")
-
+\dontrun{
dataReturned1 <- importWaterML2(URL)
dataReturn2 <- importWaterML2(URL2, TRUE)
URLmulti <- paste(baseURL,
@@ -44,9 +44,16 @@ URLmulti <- paste(baseURL,
"statCd=00003",
"parameterCd=00060",sep="&")
dataReturnMulti <- importWaterML2(URLmulti)
+
filePath <- system.file("extdata", package="dataRetrieval")
fileName <- "WaterML2Example.xml"
fullPath <- file.path(filePath, fileName)
UserData <- importWaterML2(fullPath)
}
+filePath <- system.file("extdata", package="dataRetrieval")
+fileName <- "WaterML2Example.xml"
+fullPath <- file.path(filePath, fileName)
+
+fileData <- importWaterML2(fullPath)
+}
diff --git a/man/readNWISgwl.Rd b/man/readNWISgwl.Rd
index d88a03cb..58c26067 100644
--- a/man/readNWISgwl.Rd
+++ b/man/readNWISgwl.Rd
@@ -49,11 +49,13 @@ See \url{http://waterservices.usgs.gov/rest/GW-Levels-Service.html} for more inf
}
\examples{
siteNumber <- "434400121275801"
+\dontrun{
data <- readNWISgwl(siteNumber, '','')
sites <- c("434400121275801", "375907091432201")
data2 <- readNWISgwl(sites, '','')
data3 <- readNWISgwl("420125073193001", '','')
}
+}
\seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}}
}
diff --git a/man/readNWISmeas.Rd b/man/readNWISmeas.Rd
index 27b8c28c..07b7af46 100644
--- a/man/readNWISmeas.Rd
+++ b/man/readNWISmeas.Rd
@@ -48,8 +48,10 @@ See \url{http://waterdata.usgs.gov/usa/nwis/sw} for details about surface water.
}
\examples{
siteNumbers <- c('01594440','040851325')
+\dontrun{
data <- readNWISmeas(siteNumbers)
}
+}
\seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}}
}
diff --git a/man/readNWISpeak.Rd b/man/readNWISpeak.Rd
index eef64a7a..a94eab78 100644
--- a/man/readNWISpeak.Rd
+++ b/man/readNWISpeak.Rd
@@ -48,8 +48,10 @@ Reads peak flow from NWISweb. Data is retrieved from \url{http://waterdata.usgs.
}
\examples{
siteNumbers <- c('01594440','040851325')
+\dontrun{
data <- readNWISpeak(siteNumbers)
}
+}
\seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}}
}
diff --git a/man/readNWISqw.Rd b/man/readNWISqw.Rd
index b8b16c66..bfc69ee8 100644
--- a/man/readNWISqw.Rd
+++ b/man/readNWISqw.Rd
@@ -10,7 +10,7 @@ readNWISqw(siteNumbers, parameterCd, startDate = "", endDate = "",
\arguments{
\item{siteNumbers}{character of USGS site numbers. This is usually an 8 digit number}
-\item{parameterCd}{character of USGS parameter code(s). This is usually an 5 digit number.}
+\item{parameterCd}{character of USGS parameter code(s). This is usually an 5 digit number. Can also be "all".}
\item{startDate}{character starting date for data retrieval in the form YYYY-MM-DD. Default is "" which indicates
retrieval for the earliest possible record.}
@@ -69,6 +69,9 @@ parameterCd <- c('34247','30234','32104','34220')
rawNWISqwData <- readNWISqw(siteNumbers,parameterCd,startDate,endDate)
rawNWISqwDataReshaped <- readNWISqw(siteNumbers,parameterCd,
startDate,endDate,reshape=TRUE)
+parameterCd <- "all"
+rawNWISall <- readNWISqw(siteNumbers,parameterCd,
+ startDate,endDate,reshape=TRUE)
}
}
\seealso{
diff --git a/man/readNWISrating.Rd b/man/readNWISrating.Rd
index df531c68..bafb5284 100644
--- a/man/readNWISrating.Rd
+++ b/man/readNWISrating.Rd
@@ -43,9 +43,11 @@ relate flow to stage.
}
\examples{
siteNumber <- '01594440'
+\dontrun{
data <- readNWISrating(siteNumber, "base")
attr(data, "RATING")
}
+}
\seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}}
}
diff --git a/man/readNWISsite.Rd b/man/readNWISsite.Rd
index ced723d9..84dffad4 100644
--- a/man/readNWISsite.Rd
+++ b/man/readNWISsite.Rd
@@ -69,10 +69,11 @@ comment \tab character \tab Header comments from the RDB file \cr
Imports data from USGS site file site. This function gets data from here: \url{http://waterservices.usgs.gov/}
}
\examples{
-# These examples require an internet connection to run
+\dontrun{
siteINFO <- readNWISsite('05114000')
siteINFOMulti <- readNWISsite(c('05114000','09423350'))
}
+}
\keyword{USGS}
\keyword{data}
\keyword{import}
--
GitLab