From 7c6117787ad903c94976422daf9b854909a15aea Mon Sep 17 00:00:00 2001
From: Laura DeCicco <ldecicco@usgs.gov>
Date: Tue, 22 Jan 2013 16:07:59 -0600
Subject: [PATCH] Updating formatting pages.
---
man/getDVData.Rd | 7 ++++++-
man/retrieveNWISData.Rd | 3 ++-
man/retrieveUnitNWISData.Rd | 6 +++---
3 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/man/getDVData.Rd b/man/getDVData.Rd
index 1af0f45a..7dc0a25d 100644
--- a/man/getDVData.Rd
+++ b/man/getDVData.Rd
@@ -3,7 +3,7 @@
\title{Import Daily Data for WRTDS}
\usage{
getDVData(siteNumber, ParameterCd, StartDate, EndDate,
- interactive = TRUE)
+ interactive = TRUE, convert = TRUE)
}
\arguments{
\item{siteNumber}{string USGS site number. This is
@@ -21,6 +21,11 @@
\item{interactive}{logical Option for interactive mode.
If true, there is user interaction for error handling and
data checks.}
+
+ \item{convert}{logical Option to include a conversion
+ from cfs to cms (35.314667). The default is TRUE, which
+ is appropriate for using NWIS data in the EGRET package.
+ Set this to FALSE to not include the conversion.}
}
\value{
Daily dataframe
diff --git a/man/retrieveNWISData.Rd b/man/retrieveNWISData.Rd
index e21541d8..465a537e 100644
--- a/man/retrieveNWISData.Rd
+++ b/man/retrieveNWISData.Rd
@@ -26,7 +26,7 @@
data checks.}
}
\value{
- retval dataframe with agency, site, dateTime, value, and
+ data dataframe with agency, site, dateTime, value, and
code columns
}
\description{
@@ -41,6 +41,7 @@
# These examples require an internet connection to run
rawDailyFlowData <- retrieveNWISData('01594440','00060', '1985-01-01', '1985-01-31')
rawDailyTemperatureData <- retrieveNWISData('05114000','00010', '1985-01-01', '1985-01-31', StatCd='00001',interactive=FALSE)
+rawDailyFlowAndTemperatureData <- retrieveNWISData('04085427','00010,00060', '2012-01-01', '2012-06-30', interactive=FALSE)
}
\keyword{USGS}
\keyword{data}
diff --git a/man/retrieveUnitNWISData.Rd b/man/retrieveUnitNWISData.Rd
index 3509d78c..4622f8dd 100644
--- a/man/retrieveUnitNWISData.Rd
+++ b/man/retrieveUnitNWISData.Rd
@@ -23,7 +23,7 @@
data checks.}
}
\value{
- retval dataframe with agency, site, dateTime, time zone,
+ data dataframe with agency, site, dateTime, time zone,
value, and code columns
}
\description{
@@ -37,8 +37,8 @@
\examples{
siteNumber <- '05114000'
ParameterCd <- '00060'
-StartDate <- '2012-05-01'
-EndDate <- '2012-05-02'
+StartDate <- as.character(Sys.Date())
+EndDate <- as.character(Sys.Date())
# These examples require an internet connection to run
rawData <- retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE)
}
--
GitLab