Skip to content
Snippets Groups Projects
getSampleData.r 1.57 KiB
Newer Older
  • Learn to ignore specific revisions
  • Laura A DeCicco's avatar
    Laura A DeCicco committed
    #' 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}
    #'
    #' @param siteNumber string USGS site number.  This is usually an 8 digit number
    #' @param ParameterCd string USGS parameter code.  This is usually an 5 digit number.
    #' @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
    #' getSampleData('01594440','01075', '1985-01-01', '1985-03-31', interactive=FALSE)
    #' getSampleData('05114000','00915;00931', '1985-01-01', '1985-03-31', interactive=FALSE)
    #' getSampleData('05114000','00915;00931', '', '', interactive=FALSE)
    getSampleData <- function(siteNumber,ParameterCd,StartDate,EndDate,interactive=TRUE){
      data <- getQWData(siteNumber,ParameterCd,StartDate,EndDate,interactive=interactive)
      compressedData <- compressData(data, interactive=interactive)
      Sample <- populateSampleColumns(compressedData)
      return(Sample)
    }