From d12432493de925c3a2c7dabdd03285cb710f5117 Mon Sep 17 00:00:00 2001
From: Laura DeCicco <ldecicco@usgs.gov>
Date: Thu, 27 Jun 2013 15:23:18 -0500
Subject: [PATCH] Added getSTORETSampleData function.

---
 DESCRIPTION                |  1 +
 NAMESPACE                  |  1 +
 R/getSTORETSampleData.R    | 27 ++++++++++++++++++++
 man/getSTORETSampleData.Rd | 51 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 80 insertions(+)
 create mode 100644 R/getSTORETSampleData.R
 create mode 100644 man/getSTORETSampleData.Rd

diff --git a/DESCRIPTION b/DESCRIPTION
index 906d77c3..d5de273c 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -55,6 +55,7 @@ Collate:
     'getWaterML1Data.r'
     'padVariable.r'
     'getRDB1Data.r'
+    'getSTORETSampleData.R'
 Depends:
     R (>= 2.15.0)
 Imports:
diff --git a/NAMESPACE b/NAMESPACE
index 260d754d..ddd6a541 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -20,6 +20,7 @@ export(getQWData)
 export(getQWDataFromFile)
 export(getRDB1Data)
 export(getRawQWData)
+export(getSTORETSampleData)
 export(getSampleData)
 export(getSampleDataFromFile)
 export(getSiteFileData)
diff --git a/R/getSTORETSampleData.R b/R/getSTORETSampleData.R
new file mode 100644
index 00000000..79abd67a
--- /dev/null
+++ b/R/getSTORETSampleData.R
@@ -0,0 +1,27 @@
+#' Import Sample Data for WRTDS
+#'
+#' Imports data from NWIS web service. This function gets the data from here: \url{http://qwwebservices.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}
+#' For raw data, use getQWData.  This function will retrieve the raw data, and compress it (summing constituents). See
+#' chapter 7 of the EGRET user guide for more details.
+#'
+#' @param siteNumber string site number.  If USGS, it should be in the form :'USGS-XXXXXXXXX...'
+#' @param characteristicName string
+#' @param StartDate string starting date for data retrieval in the form YYYY-MM-DD.
+#' @param EndDate string ending date for data retrieval in the form YYYY-MM-DD.
+#' @param interactive logical Option for interactive mode.  If true, there is user interaction for error handling and data checks.
+#' @keywords data import USGS WRTDS
+#' @export
+#' @return Sample dataframe
+#' @seealso \code{\link{compressData}}, \code{\link{populateSampleColumns}}
+#' @examples
+#' # These examples require an internet connection to run
+#' Sample_01075 <- getSTORETSampleData('USGS-01594440','Chloride', '', '', interactive=FALSE)
+#' Sample_All <- getSTORETSampleData('WIDNR_WQX-10032762','Specific conductance', '', '', interactive=FALSE)
+getSTORETSampleData <- function(siteNumber,characteristicName,StartDate,EndDate,interactive=TRUE){
+  data <- getWQPData(siteNumber,characteristicName,StartDate,EndDate,interactive=interactive)
+  compressedData <- compressData(data, interactive=interactive)
+  Sample <- populateSampleColumns(compressedData)
+  return(Sample)
+}
diff --git a/man/getSTORETSampleData.Rd b/man/getSTORETSampleData.Rd
new file mode 100644
index 00000000..a1fc936e
--- /dev/null
+++ b/man/getSTORETSampleData.Rd
@@ -0,0 +1,51 @@
+\name{getSTORETSampleData}
+\alias{getSTORETSampleData}
+\title{Import Sample Data for WRTDS}
+\usage{
+  getSTORETSampleData(siteNumber, characteristicName,
+    StartDate, EndDate, interactive = TRUE)
+}
+\arguments{
+  \item{siteNumber}{string site number.  If USGS, it should
+  be in the form :'USGS-XXXXXXXXX...'}
+
+  \item{characteristicName}{string}
+
+  \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{interactive}{logical Option for interactive mode.
+  If true, there is user interaction for error handling and
+  data checks.}
+}
+\value{
+  Sample dataframe
+}
+\description{
+  Imports data from NWIS web service. This function gets
+  the data from here: \url{http://qwwebservices.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}
+  For raw data, use getQWData.  This function will retrieve
+  the raw data, and compress it (summing constituents). See
+  chapter 7 of the EGRET user guide for more details.
+}
+\examples{
+# These examples require an internet connection to run
+Sample_01075 <- getSTORETSampleData('USGS-01594440','Chloride', '', '', interactive=FALSE)
+Sample_All <- getSTORETSampleData('WIDNR_WQX-10032762','Specific conductance', '', '', interactive=FALSE)
+}
+\seealso{
+  \code{\link{compressData}},
+  \code{\link{populateSampleColumns}}
+}
+\keyword{USGS}
+\keyword{WRTDS}
+\keyword{data}
+\keyword{import}
+
-- 
GitLab