Skip to content
Snippets Groups Projects
readNWISpCode.Rd 1.36 KiB
Newer Older
  • Learn to ignore specific revisions
  • Laura A DeCicco's avatar
    Laura A DeCicco committed
    % Generated by roxygen2 (4.0.2): do not edit by hand
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \name{readNWISpCode}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \alias{readNWISpCode}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \title{USGS Parameter Data Retrieval}
    \usage{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    readNWISpCode(parameterCd)
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \arguments{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \item{parameterCd}{character of USGS parameter codes (or multiple parameter codes).  These are 5 digit number codes
    
    that can be found here: \url{http://help.waterdata.usgs.gov/codes-and-parameters/parameters}. To get a
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    complete list of all current parameter codes in the USGS, use "all" as the input.}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \value{
    
    parameterData data frame with all information from the USGS about the particular parameter.
    
    \tabular{lll}{
      Name \tab Type \tab Description\cr
      parameter_cd \tab character \tab 5-digit USGS parameter code \cr
      parameter_group_nm \tab character \tab USGS parameter group name\cr
      parameter_nm \tab character \tab USGS parameter name\cr
      casrn \tab character \tab Chemical Abstracts Service (CAS) Registry Number\cr
      srsname \tab character \tab Substance Registry Services Name\cr
      parameter_units \tab character \tab Parameter units\cr
    }
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \description{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Imports data from NWIS about meaured parameter based on user-supplied parameter code or codes.
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    This function gets the data from here: \url{http://nwis.waterdata.usgs.gov/nwis/pmcodes}
    }
    \examples{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    paramINFO <- readNWISpCode(c('01075','00060','00931'))
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    }
    \keyword{USGS}
    \keyword{data}
    \keyword{import}
    \keyword{service}
    \keyword{web}