Skip to content
Snippets Groups Projects
Commit d9b5f474 authored by Laura A DeCicco's avatar Laura A DeCicco
Browse files

Updating help files.

parent 37ee9e6b
No related branches found
No related tags found
1 merge request!76Taking out external call on check.
...@@ -55,7 +55,7 @@ endDate <- "2012-10-01" ...@@ -55,7 +55,7 @@ endDate <- "2012-10-01"
offering <- '00003' offering <- '00003'
property <- '00060' property <- '00060'
obs_url <- constructNWISURL(siteNumber,property,startDate,endDate,'dv') obs_url <- constructNWISURL(siteNumber,property,startDate,endDate,'dv')
\dontrun{
data <- importWaterML1(obs_url,TRUE) data <- importWaterML1(obs_url,TRUE)
groundWaterSite <- "431049071324301" groundWaterSite <- "431049071324301"
...@@ -69,11 +69,6 @@ unitDataURL <- constructNWISURL(siteNumber,property, ...@@ -69,11 +69,6 @@ unitDataURL <- constructNWISURL(siteNumber,property,
"2013-11-03","2013-11-03",'uv') "2013-11-03","2013-11-03",'uv')
unitData <- importWaterML1(unitDataURL,TRUE) 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: # Two sites, two pcodes, one site has two data descriptors:
siteNumber <- c('01480015',"04085427") siteNumber <- c('01480015',"04085427")
obs_url <- constructNWISURL(siteNumber,c("00060","00010"),startDate,endDate,'dv') obs_url <- constructNWISURL(siteNumber,c("00060","00010"),startDate,endDate,'dv')
...@@ -91,6 +86,12 @@ inactiveSite <- importWaterML1(inactiveSite) ...@@ -91,6 +86,12 @@ inactiveSite <- importWaterML1(inactiveSite)
inactiveAndAcitive <- c("07334200","05212700") inactiveAndAcitive <- c("07334200","05212700")
inactiveAndAcitive <- constructNWISURL(inactiveAndAcitive, "00060", "2014-01-01", "2014-01-10",'dv') inactiveAndAcitive <- constructNWISURL(inactiveAndAcitive, "00060", "2014-01-01", "2014-01-10",'dv')
inactiveAndAcitive <- importWaterML1(inactiveAndAcitive) inactiveAndAcitive <- importWaterML1(inactiveAndAcitive)
}
filePath <- system.file("extdata", package="dataRetrieval")
fileName <- "WaterML1Example.xml"
fullPath <- file.path(filePath, fileName)
imporFile <- importWaterML1(fullPath,TRUE)
} }
\seealso{ \seealso{
\code{\link{renameNWISColumns}} \code{\link{renameNWISColumns}}
......
...@@ -34,7 +34,7 @@ URL2 <- paste("http://cida.usgs.gov/noreast-sos/simple?request=GetObservation", ...@@ -34,7 +34,7 @@ URL2 <- paste("http://cida.usgs.gov/noreast-sos/simple?request=GetObservation",
"featureID=MD-BC-BC-05", "featureID=MD-BC-BC-05",
"offering=RAW", "offering=RAW",
"observedProperty=WATER",sep="&") "observedProperty=WATER",sep="&")
\dontrun{
dataReturned1 <- importWaterML2(URL) dataReturned1 <- importWaterML2(URL)
dataReturn2 <- importWaterML2(URL2, TRUE) dataReturn2 <- importWaterML2(URL2, TRUE)
URLmulti <- paste(baseURL, URLmulti <- paste(baseURL,
...@@ -44,9 +44,16 @@ URLmulti <- paste(baseURL, ...@@ -44,9 +44,16 @@ URLmulti <- paste(baseURL,
"statCd=00003", "statCd=00003",
"parameterCd=00060",sep="&") "parameterCd=00060",sep="&")
dataReturnMulti <- importWaterML2(URLmulti) dataReturnMulti <- importWaterML2(URLmulti)
filePath <- system.file("extdata", package="dataRetrieval") filePath <- system.file("extdata", package="dataRetrieval")
fileName <- "WaterML2Example.xml" fileName <- "WaterML2Example.xml"
fullPath <- file.path(filePath, fileName) fullPath <- file.path(filePath, fileName)
UserData <- importWaterML2(fullPath) UserData <- importWaterML2(fullPath)
} }
filePath <- system.file("extdata", package="dataRetrieval")
fileName <- "WaterML2Example.xml"
fullPath <- file.path(filePath, fileName)
fileData <- importWaterML2(fullPath)
}
...@@ -49,11 +49,13 @@ See \url{http://waterservices.usgs.gov/rest/GW-Levels-Service.html} for more inf ...@@ -49,11 +49,13 @@ See \url{http://waterservices.usgs.gov/rest/GW-Levels-Service.html} for more inf
} }
\examples{ \examples{
siteNumber <- "434400121275801" siteNumber <- "434400121275801"
\dontrun{
data <- readNWISgwl(siteNumber, '','') data <- readNWISgwl(siteNumber, '','')
sites <- c("434400121275801", "375907091432201") sites <- c("434400121275801", "375907091432201")
data2 <- readNWISgwl(sites, '','') data2 <- readNWISgwl(sites, '','')
data3 <- readNWISgwl("420125073193001", '','') data3 <- readNWISgwl("420125073193001", '','')
} }
}
\seealso{ \seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}} \code{\link{constructNWISURL}}, \code{\link{importRDB1}}
} }
......
...@@ -48,8 +48,10 @@ See \url{http://waterdata.usgs.gov/usa/nwis/sw} for details about surface water. ...@@ -48,8 +48,10 @@ See \url{http://waterdata.usgs.gov/usa/nwis/sw} for details about surface water.
} }
\examples{ \examples{
siteNumbers <- c('01594440','040851325') siteNumbers <- c('01594440','040851325')
\dontrun{
data <- readNWISmeas(siteNumbers) data <- readNWISmeas(siteNumbers)
} }
}
\seealso{ \seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}} \code{\link{constructNWISURL}}, \code{\link{importRDB1}}
} }
......
...@@ -48,8 +48,10 @@ Reads peak flow from NWISweb. Data is retrieved from \url{http://waterdata.usgs. ...@@ -48,8 +48,10 @@ Reads peak flow from NWISweb. Data is retrieved from \url{http://waterdata.usgs.
} }
\examples{ \examples{
siteNumbers <- c('01594440','040851325') siteNumbers <- c('01594440','040851325')
\dontrun{
data <- readNWISpeak(siteNumbers) data <- readNWISpeak(siteNumbers)
} }
}
\seealso{ \seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}} \code{\link{constructNWISURL}}, \code{\link{importRDB1}}
} }
......
...@@ -10,7 +10,7 @@ readNWISqw(siteNumbers, parameterCd, startDate = "", endDate = "", ...@@ -10,7 +10,7 @@ readNWISqw(siteNumbers, parameterCd, startDate = "", endDate = "",
\arguments{ \arguments{
\item{siteNumbers}{character of USGS site numbers. This is usually an 8 digit number} \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 \item{startDate}{character starting date for data retrieval in the form YYYY-MM-DD. Default is "" which indicates
retrieval for the earliest possible record.} retrieval for the earliest possible record.}
...@@ -69,6 +69,9 @@ parameterCd <- c('34247','30234','32104','34220') ...@@ -69,6 +69,9 @@ parameterCd <- c('34247','30234','32104','34220')
rawNWISqwData <- readNWISqw(siteNumbers,parameterCd,startDate,endDate) rawNWISqwData <- readNWISqw(siteNumbers,parameterCd,startDate,endDate)
rawNWISqwDataReshaped <- readNWISqw(siteNumbers,parameterCd, rawNWISqwDataReshaped <- readNWISqw(siteNumbers,parameterCd,
startDate,endDate,reshape=TRUE) startDate,endDate,reshape=TRUE)
parameterCd <- "all"
rawNWISall <- readNWISqw(siteNumbers,parameterCd,
startDate,endDate,reshape=TRUE)
} }
} }
\seealso{ \seealso{
......
...@@ -43,9 +43,11 @@ relate flow to stage. ...@@ -43,9 +43,11 @@ relate flow to stage.
} }
\examples{ \examples{
siteNumber <- '01594440' siteNumber <- '01594440'
\dontrun{
data <- readNWISrating(siteNumber, "base") data <- readNWISrating(siteNumber, "base")
attr(data, "RATING") attr(data, "RATING")
} }
}
\seealso{ \seealso{
\code{\link{constructNWISURL}}, \code{\link{importRDB1}} \code{\link{constructNWISURL}}, \code{\link{importRDB1}}
} }
......
...@@ -69,10 +69,11 @@ comment \tab character \tab Header comments from the RDB file \cr ...@@ -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/} Imports data from USGS site file site. This function gets data from here: \url{http://waterservices.usgs.gov/}
} }
\examples{ \examples{
# These examples require an internet connection to run \dontrun{
siteINFO <- readNWISsite('05114000') siteINFO <- readNWISsite('05114000')
siteINFOMulti <- readNWISsite(c('05114000','09423350')) siteINFOMulti <- readNWISsite(c('05114000','09423350'))
} }
}
\keyword{USGS} \keyword{USGS}
\keyword{data} \keyword{data}
\keyword{import} \keyword{import}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment