R/setup.R

Defines functions nytimes_key

Documented in nytimes_key

#' Setup
#' 
#' Setup API key to be used for subsequent calls.
#' 
#' @param key Your API key, freely available at \url{https://developer.nytimes.com}.
#' 
#' @note You can specify \code{NYTIMES_API_KEY} as environment variable, likely in your \code{.Renviron} file.
#' 
#' @examples
#' \dontrun{
#' nytimes_key("xXXxxXxXxXXx")  
#' }
#' 
#' @import purrr
#' @import httr
#' @import assertthat
#' 
#' @export
nytimes_key <- function(key){
  assert_that(!missing(key), msg = "Missing key")
  Sys.setenv(NYTIMES_API_KEY = key)
}
news-r/nytimes documentation built on Sept. 7, 2024, 1:02 a.m.