Skip to content
Snippets Groups Projects
getQWData.Rd 1.73 KiB
Newer Older
  • Learn to ignore specific revisions
  • Laura A DeCicco's avatar
    Laura A DeCicco committed
    \name{getQWData}
    \alias{getQWData}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \title{Data Import for USGS NWIS Water Quality Data}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \usage{
    
    getQWData(siteNumber, ParameterCd, StartDate, EndDate, interactive = TRUE)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \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. Multiple parameter codes can
      be inputted with a ';' separator.  Leaving this blank
      will return all of the measured values during the
      specified time period.}
    
      \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{
    
    retval dataframe with first column dateTime, and at least
    one qualifier and value columns (subsequent qualifier/value
    columns could follow depending on requested parameter
    codes)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \description{
    
    Imports and processes data from NWIS web service. This
    function gets the data from here:
    \url{http://www.waterqualitydata.us} 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
    }
    \examples{
    # These examples require an internet connection to run
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    rawProcessedSample <- getQWData('01594440','01075', '1985-01-01', '1985-03-31')
    rawProcessedSampleAll <- getQWData('05114000','', '1985-01-01', '1985-03-31')
    
    rawProcessedSampleSelect <- getQWData('05114000','00915;00931', '1985-01-01', '1985-04-30')
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \keyword{data}
    \keyword{import}
    \keyword{service}
    \keyword{web}