R/mapdeck_tokens.R

In mapdeck: Interactive Maps Using 'Mapbox GL JS' and 'Deck.gl'

#' Mapdeck_tokens
#'
#' Retrieves the mapdeck token that has been set
#'
#' @export
mapdeck_tokens <- function() {

	if(!is.na( getOption("mapdeck")[["mapdeck"]][["mapbox"]] ) ) {
		return( getOption("mapdeck") )
	}

	if( !is.null( get_access_token() ) ){
		return( get_access_token() )
	}

	cat("no tokens found")
	return(invisible())

}

#' @export
print.mapdeck_api <- function(x, ...) {

	for (i in 1:length(x)) {

		cat("Mapdeck tokens\n")

		for (j in 1:length(x[[i]])){
			cat(" - ", names(x[[i]])[j], ": ")
			key <- x[[i]][[j]]
			cat(ifelse(is.na(key), "", key), "\n")
		}
	}
}

#' Set Token
#'
#' Sets an access token so it's available for all mapdeck calls. See details
#'
#' @param token Mapbox access token
#'
#' @details
#' Use \code{set_token} to make access tokens available for all the \code{mapdeck()}
#' calls in a session so you don't have to keep specifying the \code{token} argument
#' each time
#'
#' @export
set_token <- function(token) {

	options <- getOption("mapdeck")
	api <- "mapbox" ## future-proofing for other api keys

	options[['mapdeck']][[api]] <- token
	class(options) <- "mapdeck_api"
	options(mapdeck = options)
	invisible(NULL)
}


#' Clear tokens
#'
#' Clears the access tokens
#'
#' @export
clear_tokens <- function() {

	options <- list(
		mapdeck = list(
			mapbox = NA_character_
		)
	)
	attr(options, "class") <- "mapdeck_api"
	options(mapdeck = options)

}

get_access_token <- function(api = "mapbox") {

	api <- getOption("mapdeck")[['mapdeck']][[api]]
	if( is.null( api ) || is.na( api ) ) {
		e <- Sys.getenv()
		e <- e[ grep( "mapbox|mapdeck", names( e ), ignore.case = TRUE ) ]

		api <- unique( as.character( e ) )
		if( length( api ) > 1 ) {
			warning("Multiple MAPBOX API tokens found in Sys.getenv(), using the first one")
		}
	}
	if(length(api) == 0) api <- NULL
	return(api[1L])
}