R/annotation-utils.R

Defines functions .bullets mess_hint mess_numb mess_warn mess_fail mess_succ mess_info .cnumb_bg .cnumb .cfail_bg .cfail .csucc_bg .csucc .chint_bg .chint .cwarn_bg .cwarn .cinfo_bg .cinfo

Documented in .bullets .cfail .cfail_bg .chint .chint_bg .cinfo .cinfo_bg .cnumb .cnumb_bg .csucc .csucc_bg .cwarn .cwarn_bg mess_fail mess_hint mess_info mess_numb mess_succ mess_warn

#' Standardized message colours
#' @param ... the text to be coloured.
#' @return A function to colour text
#' @usage NULL
#' @importFrom crayon make_style
#' @keywords internal
#' @name message_colours
NULL

#' @rdname message_colours
#' @keywords internal
.cinfo = function(...) {make_style("dodgerblue4")(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.cinfo_bg = function(...) {make_style("white")(make_style("dodgerblue4", bg = TRUE)(paste0(list(...),collapse = "")))}
#' @keywords internal
#' @rdname message_colours
.cwarn = function(...) {make_style("chocolate1")(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.cwarn_bg = function(...) {make_style("chocolate1", bg = TRUE)(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.chint = function(...) {make_style("deeppink")(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.chint_bg = function(...) {make_style("deeppink", bg = TRUE)(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.csucc = function(...) {make_style("green")(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.csucc_bg = function(...) {make_style("green", bg = TRUE)(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.cfail = function(...) {make_style("red")(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.cfail_bg = function(...) {make_style("white")((make_style("red", bg = TRUE)(paste0(list(...), collapse = ""))))}
#' @keywords internal
#' @rdname message_colours
.cnumb = function(...) {make_style("cyan")(paste0(list(...),collapse = ""))}
#' @keywords internal
#' @rdname message_colours
.cnumb_bg = function(...) {make_style("cyan", bg = TRUE)(paste0(list(...),collapse = ""))}

#' Display coloured messages
#'
#' @param header message title.
#' @param message the message.
#' @param pre optional string to be displayed before the message bullet (such as \code{'\n'}).
#' @keywords internal
#' @return A coloured message.
#' @name messages
NULL


#' @rdname messages
#' @keywords internal
#' @export
mess_info = function(header, message, pre=""){cat(pre, .cinfo(.bullets()$info),header,message,sep = "")}
#' @keywords internal
#' @rdname messages
#' @export
mess_succ = function(header, message, pre=""){cat(pre, .csucc(.bullets()$succ),header,message,sep = "")}
#' @keywords internal
#' @rdname messages
#' @export
mess_fail = function(header, message, pre=""){cat(pre, .cfail(.bullets()$fail),.cfail(header), .cfail(message),sep = "")}
#' @keywords internal
#' @rdname messages
#' @export
mess_warn = function(header, message, pre=""){cat(pre, .cwarn(.bullets()$warn),.cwarn(header), .cwarn(message),sep = "")}
#' @keywords internal
#' @rdname messages
#' @export
mess_numb = function(header, message, pre=""){cat(pre, .cnumb(.bullets()$numb),header, .cnumb(message),sep = "")}
#' @keywords internal
#' @rdname messages
#' @export
mess_hint = function(message, header="", pre=""){cat(pre, .chint(.bullets()$hint),.chint(header), .chint(message),sep = "")}

#' Bullets
#' @keywords internal
#' @return A list of various coloured bullets
.bullets = function() {
  list(info=.cinfo(" \u25ba "), succ=.csucc(" \u25ba "), fail=.cfail(" \u25ba "),
       warn=.cwarn(" \u25ba "), numb=.cnumb(" \u25ba "), hint=.chint(" \u25ba "))
}

Try the hgutils package in your browser

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

hgutils documentation built on March 31, 2022, 5:06 p.m.