getDataAvailability.r

#' USGS data availability
#'
#' Imports a table of available parameters, period of record, and count.
#'
#' @param siteNumber string USGS site number.
#' @param type vector string. Options are "uv", "dv", "qw"
#' @keywords data import USGS web service
#' @return retval dataframe with all information found in the expanded site file
#' @export
#' @import RCurl
#' @examples
#' # These examples require an internet connection to run
#' availableData <- getDataAvailability('05114000')
#' # To find just unit value ('instantaneous') data:
#' uvData <- getDataAvailability('05114000',type="uv")
#' uvDataMulti <- getDataAvailability(c('05114000','09423350'),type="uv")
getDataAvailability <- function(siteNumber,type=c("uv","dv","qw")){
  
  siteNumber <- paste(siteNumber,collapse=",")
  
  urlSitefile <- paste("http://waterservices.usgs.gov/nwis/site/?format=rdb&seriesCatalogOutput=true&sites=",siteNumber,sep = "")
 
  doc = tryCatch({
    h <- basicHeaderGatherer()
    doc <- getURL(urlSitefile, headerfunction = h$update)
    
  }, warning = function(w) {
    message(paste("URL caused a warning:", urlSitefile))
    message(w)
  }, error = function(e) {
    message(paste("URL does not seem to exist:", urlSitefile))
    message(e)
    return(NA)
  }) 
  
  if(h$value()["Content-Type"] == "text/plain;charset=UTF-8"){
    SiteFile <- read.delim(
      textConnection(doc),
      header = TRUE,
      quote="\"",
      dec=".",
      sep='\t',
      colClasses=c('character'),
      fill = TRUE,
      comment.char="#")
    
    SiteFile <- SiteFile[-1,]
    
    SiteFile <- with(SiteFile, data.frame(site_no=site_no, parameter_cd=parm_cd, statCd=stat_cd, startDate=begin_date,endDate=end_date, count=count_nu,service=data_type_cd,stringsAsFactors = FALSE))
    
    SiteFile <- SiteFile[!is.na(SiteFile$parameter_cd),]
    SiteFile <- SiteFile["" != SiteFile$parameter_cd,]
    SiteFile$startDate <- as.Date(SiteFile$startDate)
    SiteFile$endDate <- as.Date(SiteFile$endDate)
    SiteFile$count <- as.numeric(SiteFile$count)
    
    pCodes <- unique(SiteFile$parameter_cd)
    
    pcodeINFO <- parameterCdFile[parameterCdFile$parameter_cd %in% pCodes,]
    SiteFile <- merge(SiteFile,pcodeINFO,by="parameter_cd")
    SiteFile <- SiteFile[SiteFile$service %in% type,]
    return(SiteFile)
  } else {
    message(paste("URL caused an error:", urlSitefile))
    message("Content-Type=",h$value()["Content-Type"])
    return(NA)
  }
}