R/utils-format-message.R

In portalr: Create Useful Summaries of the Portal Data

#' Format content as a variable value
#'
#' @param ... strings
#' @return a formatted string to output
#'
#' @export
format_value <- function(...)
{
    x <- paste0(..., collapse = "")
    x <- encodeString(x, quote = "'")
    crayon::blue(x)
}

#' Format content as an action to be performed by the user
#'
#' @param ... strings
#' @return a formatted string to output
#'
#' @export
format_todo <- function(...)
{
    paste0(crayon::red(clisymbols::symbol$bullet), " ", ..., collapse = "")
}

#' Format content as code
#'
#' @param ... strings
#' @return a formatted string to output
#'
#' @export
format_code <- function(...)
{
    x <- paste0(..., collapse = "")
    x <- encodeString(x, quote = "`")
    crayon::silver(x)
}