From cf41677ab8be8bbbb1dc98320f3cdf2292af5728 Mon Sep 17 00:00:00 2001
From: Laura DeCicco <ldecicco@usgs.gov>
Date: Thu, 13 Dec 2012 09:30:09 -0600
Subject: [PATCH] Latest build with unit value code addition.
---
DESCRIPTION | 1 +
NAMESPACE | 1 +
R/getStoretData.r | 6 ++---
R/getWQPData.r | 6 ++---
R/retrieveUnitNWISData.r | 2 +-
man/getParameterInfo.Rd | 6 ++---
man/getStoretData.Rd | 6 ++---
man/getWQPData.Rd | 8 +++---
man/retrieveUnitNWISData.Rd | 53 +++++++++++++++++++++++++++++++++++++
9 files changed, 72 insertions(+), 17 deletions(-)
create mode 100644 man/retrieveUnitNWISData.Rd
diff --git a/DESCRIPTION b/DESCRIPTION
index ab9bee77..061daff2 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -47,6 +47,7 @@ Collate:
'dataOverview.r'
'getStoretData.r'
'getWQPData.r'
+ 'retrieveUnitNWISData.r'
Depends:
R (>= 2.15.0),
zoo,
diff --git a/NAMESPACE b/NAMESPACE
index a60bec6b..97289b5c 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -29,5 +29,6 @@ export(populateSampleColumns)
export(populateSiteINFO)
export(removeDuplicates)
export(retrieveNWISData)
+export(retrieveUnitNWISData)
exportClasses(fluxUnit)
import(zoo)
diff --git a/R/getStoretData.r b/R/getStoretData.r
index af1b5ec0..263a4278 100644
--- a/R/getStoretData.r
+++ b/R/getStoretData.r
@@ -15,9 +15,9 @@
#' @export
#' @examples
#' # These examples require an internet connection to run
-#' getStoretData('01594440','01075', '1985-01-01', '1985-03-31')
-#' getStoretData('05114000','', '1985-01-01', '1985-03-31')
-#' getStoretData('05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE)
+#' \dontrun{getStoretData('01594440','01075', '1985-01-01', '1985-03-31')}
+#' \dontrun{getStoretData('05114000','', '1985-01-01', '1985-03-31')}
+#' \dontrun{getStoretData('05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE)}
getStoretData <- function(siteNumber,characteristicName,StartDate,EndDate,interactive=TRUE){
siteNumber <- formatCheckSiteNumber(siteNumber, interactive=interactive)
StartDate <- formatCheckDate(StartDate, "StartDate", interactive=interactive)
diff --git a/R/getWQPData.r b/R/getWQPData.r
index 2e0536bf..c9f214fe 100644
--- a/R/getWQPData.r
+++ b/R/getWQPData.r
@@ -15,9 +15,9 @@
#' @export
#' @examples
#' # These examples require an internet connection to run
-#' getWQPData('USGS-01594440','Chloride', '', '')
-#' getWQPData('USGS-05114000','Suspended Sediment Discharge;Suspended sediment concentration (SSC);Suspended sediment discharge', '1975-01-01', '1995-03-31')
-#' getWQPData('USGS-05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE)
+#' \dontrun{getWQPData('USGS-01594440','Chloride', '', '')}
+#' \dontrun{getWQPData('USGS-05114000','Suspended Sediment Discharge;Suspended sediment concentration (SSC);Suspended sediment discharge', '1975-01-01', '1995-03-31')}
+#' \dontrun{getWQPData('USGS-05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE)}
getWQPData <- function(siteNumber,characteristicName,StartDate,EndDate,interactive=TRUE){
StartDate <- formatCheckDate(StartDate, "StartDate", interactive=interactive)
diff --git a/R/retrieveUnitNWISData.r b/R/retrieveUnitNWISData.r
index 08267c39..9fb05062 100644
--- a/R/retrieveUnitNWISData.r
+++ b/R/retrieveUnitNWISData.r
@@ -17,7 +17,7 @@
#' siteNumber <- '05114000'
#' ParameterCd <- '00060'
#' StartDate <- '2012-05-01'
-#' EndDate <- '2012-05-31'
+#' EndDate <- '2012-05-02'
#' # These examples require an internet connection to run
#' retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE)
retrieveUnitNWISData <- function (siteNumber,ParameterCd,StartDate,EndDate,interactive=TRUE){
diff --git a/man/getParameterInfo.Rd b/man/getParameterInfo.Rd
index e12aa52d..d3dccffd 100644
--- a/man/getParameterInfo.Rd
+++ b/man/getParameterInfo.Rd
@@ -18,9 +18,9 @@
short name, units, and CAS registry numbers)
}
\description{
- Imports data from NWIS web service concerning meaured
- parameter based on user-supplied parameter code. This
- function gets the data from here:
+ Imports data from NWIS about meaured parameter based on
+ user-supplied parameter code. This function gets the data
+ from here:
\url{http://nwis.waterdata.usgs.gov/nwis/pmcodes}
}
\examples{
diff --git a/man/getStoretData.Rd b/man/getStoretData.Rd
index b8a5eaa7..f261d80e 100644
--- a/man/getStoretData.Rd
+++ b/man/getStoretData.Rd
@@ -41,9 +41,9 @@
}
\examples{
# These examples require an internet connection to run
-getStoretData('01594440','01075', '1985-01-01', '1985-03-31')
-getStoretData('05114000','', '1985-01-01', '1985-03-31')
-getStoretData('05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE)
+\dontrun{getStoretData('01594440','01075', '1985-01-01', '1985-03-31')}
+\dontrun{getStoretData('05114000','', '1985-01-01', '1985-03-31')}
+\dontrun{getStoretData('05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE)}
}
\keyword{USGS}
\keyword{data}
diff --git a/man/getWQPData.Rd b/man/getWQPData.Rd
index f946157b..d18d3b6a 100644
--- a/man/getWQPData.Rd
+++ b/man/getWQPData.Rd
@@ -1,6 +1,6 @@
\name{getWQPData}
\alias{getWQPData}
-\title{Data Import for Water Quality Portal}
+\title{Data Import from Water Quality Portal}
\usage{
getWQPData(siteNumber, characteristicName, StartDate,
EndDate, interactive = TRUE)
@@ -43,9 +43,9 @@
}
\examples{
# These examples require an internet connection to run
-getWQPData('USGS-01594440','Chloride', '', '')
-getWQPData('USGS-05114000','Suspended Sediment Discharge;Suspended sediment concentration (SSC);Suspended sediment discharge', '1975-01-01', '1995-03-31')
-getWQPData('USGS-05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE)
+\dontrun{getWQPData('USGS-01594440','Chloride', '', '')}
+\dontrun{getWQPData('USGS-05114000','Suspended Sediment Discharge;Suspended sediment concentration (SSC);Suspended sediment discharge', '1975-01-01', '1995-03-31')}
+\dontrun{getWQPData('USGS-05114000','00915;00931', '1985-01-01', '1985-04-30', interactive=FALSE)}
}
\keyword{WQP}
\keyword{data}
diff --git a/man/retrieveUnitNWISData.Rd b/man/retrieveUnitNWISData.Rd
new file mode 100644
index 00000000..a555593f
--- /dev/null
+++ b/man/retrieveUnitNWISData.Rd
@@ -0,0 +1,53 @@
+\name{retrieveUnitNWISData}
+\alias{retrieveUnitNWISData}
+\title{Data Import for Instantaneous USGS NWIS Data}
+\usage{
+ retrieveUnitNWISData(siteNumber, ParameterCd, StartDate,
+ EndDate, interactive = TRUE)
+}
+\arguments{
+ \item{siteNumber}{string USGS site number. This is
+ usually an 8 digit number}
+
+ \item{ParameterCd}{string USGS parameter code. This is
+ usually an 5 digit number.}
+
+ \item{StartDate}{string starting date for data retrieval
+ in the form YYYY-MM-DD.}
+
+ \item{EndDate}{string ending date for data retrieval in
+ the form YYYY-MM-DD.}
+
+ \item{StatCd}{string USGS statistic code. This is usually
+ 5 digits. Daily mean (00003) is the default.}
+
+ \item{interactive}{logical Option for interactive mode.
+ If true, there is user interaction for error handling and
+ data checks.}
+}
+\value{
+ retval dataframe with agency, site, dateTime, value, and
+ code columns
+}
+\description{
+ Imports data from NWIS web service. This function gets
+ the data from here: \url{http://waterservices.usgs.gov/}
+ A list of parameter codes can be found here:
+ \url{http://nwis.waterdata.usgs.gov/nwis/pmcodes/} A list
+ of statistic codes can be found here:
+ \url{http://nwis.waterdata.usgs.gov/nwis/help/?read_file=stat&format=table}
+}
+\examples{
+siteNumber <- '05114000'
+ParameterCd <- '00060'
+StartDate <- '2012-05-01'
+EndDate <- '2012-05-02'
+# These examples require an internet connection to run
+retrieveUnitNWISData(siteNumber,ParameterCd,StartDate,EndDate,interactive=FALSE)
+}
+\keyword{USGS}
+\keyword{data}
+\keyword{import}
+\keyword{service}
+\keyword{web}
+
--
GitLab