R/color_terminal.R

In rpkgs/Ipaper: Collection of personal practical R functions

#' @export
crayon::bold

#' @export
crayon::red

#' @export
crayon::green

#' @export
crayon::underline

#' Colored terminal output
#'
#' @param ... Strings to style.
#' @importFrom crayon green red bold underline
#'
#' @keywords internal
#' @rdname ok
#' @export
ok <- function(...) cat(green(...), sep = "\n")

#' @rdname ok
#' @export
warn <- function(...) cat(red(...), sep = "\n")
# warn  <- function(...) cat(red $ underline (...))

width_str <- function(str, width = NULL) {
    if (!is.null(width) && width > 0) {
        pattern <- sprintf("%%%ds", width)
        sprintf(pattern, str)
    } else {
        sprintf("%s", str)
    }
}

#' @rdname ok
#' @export
num_bad <- function(str, width = NULL, ...) {
    str <- width_str(str, width)
    bold$ underline$ red(str)
}

#' @rdname ok
#' @export
num_good <- function(str, width = NULL, ...) {
    str <- width_str(str, width)
    bold$ underline$ green(str)
}