Skip to content
Snippets Groups Projects
readWQPqw.Rd 1.68 KiB
Newer Older
  • Learn to ignore specific revisions
  • % Generated by roxygen2 (4.0.2): do not edit by hand
    
    \name{getWQPqwData}
    \alias{getWQPqwData}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \alias{readWQPqw}
    
    \title{Raw Data Import for Water Quality Portal}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \usage{
    
    getWQPqwData(siteNumber, parameterCd, startDate = "", endDate = "")
    
    readWQPqw(siteNumber, parameterCd, startDate = "", endDate = "")
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \arguments{
    
    \item{siteNumber}{character site number. This needs to include the full agency code prefix.}
    
    \item{parameterCd}{vector of USGS 5-digit parameter code or characteristicNames.
    
    Leaving this blank will return all of the measured values during the specified time period.}
    
    \item{startDate}{character starting date for data retrieval in the form YYYY-MM-DD.}
    
    \item{endDate}{character ending date for data retrieval in the form YYYY-MM-DD.}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \value{
    
    retval dataframe raw data returned from the Water Quality Portal. Additionally, a POSIXct dateTime column is supplied for
    start and end times.
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \description{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Imports data from the Water Quality Portal.
    This function gets the data from here: \url{http://www.waterqualitydata.us}. There
    are four required input arguments: siteNumber, parameterCd, startDate, and endDate.
    parameterCd can either be a USGS 5-digit code, or a characteristic name. The sites can be
    either USGS, or other Water Quality Portal offered sites. It is required to use the 'full'
    site name, such as 'USGS-01234567'.
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \examples{
    
    \dontrun{
    rawPcode <- readWQPqw('USGS-01594440','01075', '', '')
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    rawCharacteristicName <- readWQPqw('WIDNR_WQX-10032762','Specific conductance', '', '')
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \seealso{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \code{\link{readWQPdata}}, \code{\link{whatWQPsites}},
    \code{\link{readNWISqw}}, and \code{\link{importWQP}}
    
    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}