R/Quandlconfig.R

In SanFranciscoFogg/quandl-r: API Wrapper for Quandl.com

#' Query or set Quandl API key
#' @param api_key Optionally passed parameter to set Quandl \code{api_key}.
#' @return Returns invisibly the currently set \code{api_key}.
#' @examples \dontrun{
#' Quandl.api_key('foobar')
#' }
#' @export
Quandl.api_key <- function(api_key) {
  if (!missing(api_key)) {
    options(Quandl.api_key = api_key)
  }
  invisible(getOption('Quandl.api_key'))
}

#' Query or set Quandl API token
#'
#' Deprecated. Alias of \code{\link{Quandl.api_key}}
#'
#' @param auth_token Optionally passed parameter to set Quandl \code{auth_token}.
#' @return Returns invisibly the currently set \code{auth_token}.
#' @seealso \code{\link{Quandl}}
#' @examples \dontrun{
#' Quandl.auth('foobar')
#' }
#' @export
Quandl.auth <- function(auth_token) {
  .Deprecated('Quandl.api_key')
  Quandl.api_key(auth_token)
}

Quandl.api_version <- function(api_version) {
  if (!missing(api_version)) {
    options(Quandl.api_version = api_version)
  }
  invisible(getOption('Quandl.api_version'))
}

Quandl.base_url <- function(base_url) {
  if (!missing(base_url)) {
    options(Quandl.base_url = base_url)
  }
  invisible(getOption('Quandl.base_url', 'https://www.quandl.com/api/v3'))
}