R/clear_token.R

Defines functions clear_token

Documented in clear_token

#' clear_token
#'
#' Deletes the token from the key ring.
#'
#' @param username the ices username that you require a token for,
#'   Default: \code{getOption("ices.username")}
#'
#' @return no return value
#'
#' @examples
#' \dontrun{
#' clear_token()
#' }
#'
#'
#' @rdname clear_token
#'
#'
#' @export
clear_token <- function(username = get_username()) {
  if (is.null(username)) {
    return (NULL)
  }

  message("Deleting token for user ICES\\", username)

  user_files <- list.files(config_dir(), full.names = TRUE)

  unlink(user_files[grep(paste0(username, ".dcf"), user_files)])
}

Try the icesConnect package in your browser

Any scripts or data that you put into this service are public.

icesConnect documentation built on June 8, 2025, 10:53 a.m.