Skip to content
Snippets Groups Projects
getSampleData.Rd 1.63 KiB
Newer Older
  • Learn to ignore specific revisions
  • Laura A DeCicco's avatar
    Laura A DeCicco committed
    \name{getSampleData}
    \alias{getSampleData}
    \title{Import Sample Data for WRTDS}
    \usage{
      getSampleData(siteNumber, ParameterCd, StartDate,
        EndDate, interactive = TRUE)
    }
    \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.}
    
      \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://nwis.waterdata.usgs.gov/nwis/qwdata/} A list
      of parameter codes can be found here:
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
      \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
    }
    \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', '', '')
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \seealso{
      \code{\link{compressData}},
      \code{\link{populateSampleColumns}}
    }
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \keyword{USGS}
    \keyword{WRTDS}
    
    \keyword{data}
    \keyword{import}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed