R/has_color.R

In crayon: Colored Terminal Output

#' Does the current R session support ANSI colors?
#'
#' From crayon 2.0.0, this function is simply a wrapper on
#' [num_ansi_colors()].
#'
#' @return `TRUE` if the current R session supports color.
#'
#' @export
#' @examples
#' has_color()

has_color <- function() {
  num_ansi_colors() > 1L
}

#' Number of colors the terminal supports
#'
#' From crayon version 2.0.0, this function is a simple wrapper on
#' [num_ansi_colors()], with the additional twist that the `crayon.colors`
#' option is still obseved, and takes precedence, for compatibility.
#'
#' @param forget Ignored. Included for backwards compatibility.
#' @return Number of ANSI colors.
#'
#' @export
#' @examples
#' num_colors()

num_colors <- function(forget = FALSE) {
  cray_opt_num <- getOption("crayon.colors", NULL)
  if (!is.null(cray_opt_num)) return(as.integer(cray_opt_num))
  num_ansi_colors()
}