Skip to content
Snippets Groups Projects
getSampleData.r 1.88 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://nwis.waterdata.usgs.gov/nwis/qwdata/}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    #' 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}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    #' For raw data, use getQWData.  This function will retrieve the raw data, and compress it (summing constituents). See
    
    #' section 3.4 of the vignette for more details.
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    #'
    #' @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.
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    #' @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 <- getSampleData('01594440','01075', '1985-01-01', '1985-03-31')
    #' Sample_All <- getSampleData('05114000','00915;00931', '1985-01-01', '1985-03-31')
    #' Sample_Select <- getSampleData('05114000','00915;00931', '', '')
    
    getSampleData <- function(siteNumber,parameterCd,startDate,endDate,interactive=TRUE){
      rawSample <- retrieveNWISqwData(siteNumber,parameterCd,startDate,endDate)
    
      #rawSample$dateTime <- strptime(rawSample$dateTime,"%Y-%m-%d %H:%M:%S")
    
      rawSample$dateTime <- as.Date(rawSample$dateTime)
      rawSample$site <- NULL
      compressedData <- compressData(rawSample, interactive=interactive)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
      Sample <- populateSampleColumns(compressedData)
      return(Sample)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }