Skip to content
Snippets Groups Projects
whatNWISsites.Rd 1.51 KiB
Newer Older
  • Learn to ignore specific revisions
  • % Generated by roxygen2 (4.1.0): do not edit by hand
    % Please edit documentation in R/whatNWISsites.R
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \name{whatNWISsites}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    \alias{whatNWISsites}
    
    \title{Site Data Import from NWIS}
    \usage{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    whatNWISsites(...)
    
    }
    \arguments{
    \item{\dots}{see \url{http://waterservices.usgs.gov/rest/Site-Service.html#Service} for a complete list of options}
    }
    \value{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    A data frame with at least the following columns:
    \tabular{lll}{
    Name \tab Type \tab Description \cr
    agency_cd \tab character \tab The NWIS code for the agency reporting the data\cr
    site_no \tab character \tab The USGS site number \cr
    station_nm \tab character \tab Station name \cr
    site_tp_cd \tab character \tab Site type code \cr
    dec_lat_va \tab numeric \tab Decimal latitude \cr
    dec_long_va \tab numeric \tab Decimal longitude \cr
    queryTime \tab POSIXct \tab Query time \cr
    }
    
    There are also several useful attributes attached to the data frame:
    \tabular{lll}{
    Name \tab Type \tab Description \cr
    url \tab character \tab The url used to generate the data \cr
    queryTime \tab POSIXct \tab The time the data was returned \cr
    }
    
    }
    \description{
    Returns a list of sites from the NWIS web service. This function gets the data from: \url{http://waterservices.usgs.gov/rest/Site-Test-Tool.html}.
    Arguments to the function should be based on \url{http://waterservices.usgs.gov/rest/Site-Service.html#Service}
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    Mapper format is used
    
    }
    \examples{
    
    Laura A DeCicco's avatar
    Laura A DeCicco committed
    siteListPhos <- whatNWISsites(stateCd="OH",parameterCd="00665")
    
    \keyword{NWIS}
    \keyword{data}
    \keyword{import}
    \keyword{service}
    \keyword{web}