R/download_coastal_sites.R

In mps9506/wd4tx: Access 'TWDB' Water Data For Texas

#' Download 'TWDB' Coastal Station Information
#'
#' @param all_stations logical. Defaults is FALSE. If FALSE, returns all
#'   stations for which actual data is available. If TRUE, returns all stations
#'   regardless of data availability.
#' @param opts list of curl options passed to crul::HttpClient()
#'
#' @return tibble
#' @export
download_coastal_sites <- function(all_stations = FALSE,
                                   opts = list()) {
  url <- "https://www.waterdatafortexas.org/coastal/api/stations"
  path <- NULL

  if(isTRUE(all_stations))
    args = list(all = "true")
  else args = list(all = "false")

  ## download
  content <- get_download(url,
                          path,
                          args,
                          accept = "json",
                          opts = opts)

  ## parse the returned json
  content <- jsonlite::fromJSON(content)
  attr.url <- attr(content, 'url')

  ## return as tibble
  content <- tibble::as_tibble(content)
  attr(content, 'url') <- attr.url

  return(content)
  }