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

Added getSTORETSampleData function.

parent c2164975
No related branches found
No related tags found
No related merge requests found
......@@ -55,6 +55,7 @@ Collate:
'getWaterML1Data.r'
'padVariable.r'
'getRDB1Data.r'
'getSTORETSampleData.R'
Depends:
R (>= 2.15.0)
Imports:
......
......@@ -20,6 +20,7 @@ export(getQWData)
export(getQWDataFromFile)
export(getRDB1Data)
export(getRawQWData)
export(getSTORETSampleData)
export(getSampleData)
export(getSampleDataFromFile)
export(getSiteFileData)
......
#' 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)
}
\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}
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