R/gs_clients.R

In ropensci/rgauges: R client for the Gaug.es API

#' Returns an array of your API clients.
#'
#' @export
#'
#' @template all
#' @param key API key. If left NULL, function looks for key in your options settings
#' defined in the keyname parameter
#' @param keyname Your API key name in your .Rprofile file
#' @param ... Curl debugging options passed in to \code{\link[httr]{GET}}
#' @examples \dontrun{
#' # Default key name is GaugesKey
#' gs_clients()
#'
#' library("httr")
#' gs_clients(config=verbose())
#' }
gs_clients <- function(key=NULL, keyname='GaugesKey', ...)
{
  if(is.null(key))
    key <- getOption(keyname, stop("you need an API key for Gaug.es data"))
  gs_GET(paste0(gsbase(), '/clients'), keyname, key, args, ...)
}