crayons: Wrappers for Package 'crayon' Functions to Style and Color...

In j-martineau/uj: Utilities by JAM

Wrappers for Package crayon Functions to Style and Color Console Text

Description

Functions in this family apply styles and colors to text for display on the console, where the text to display is identified by collapsing ... args into a character scalar.

Usage

crayons()

st_vals(st = NULL)

bg_vals(bg = NULL)

fg_vals(fg = NULL)

st_bld(..., d = " ")

st_itl(..., d = " ")

st_und(..., d = " ")

st_res(..., d = " ")

st_def(..., d = " ")

st_pln(..., d = " ")

st(st, ..., d = " ")

fg_blk(..., d = " ")

fg_blu(..., d = " ")

fg_cyn(..., d = " ")

fg_def(..., d = " ")

fg_grn(..., d = " ")

fg_gry(..., d = " ")

fg_mag(..., d = " ")

fg_red(..., d = " ")

fg_sil(..., d = " ")

fg_slv(..., d = " ")

fg_wht(..., d = " ")

fg_yel(..., d = " ")

fg(fg, ..., d = " ")

bg_blk(..., d = " ")

bg_blu(..., d = " ")

bg_cyn(..., d = " ")

bg_def(..., d = " ")

bg_grn(..., d = " ")

bg_mag(..., d = " ")

bg_red(..., d = " ")

bg_wht(..., d = " ")

bg_yel(..., d = " ")

bg(bg, ..., d = " ")

txt(..., bg = NULL, fg = NULL, st = NULL, d = " ")

Arguments

st	A quoted or unquoted, case-insensitive, character scalar text style from st_vals(). May also be NULL for function st_vals.
bg	A quoted or unquoted, case-insensitive, character scalar text background color from bg_vals(). May also be NULL for function bg_vals.
fg	A quoted or unquoted, case-insensitive, character scalar text foreground color from fg_vals(). May also be NULL for function fg_vals.
...	An arbitrary number of objects to be collapsed to a character scalar to be styled.
d	A non-NA character scalar delimiter for collapsing ... args into a character scalar.

Value

A character vector

⁠st_vals, fg_vals, bg_vals⁠

A character scalar

All others

Background color functions

bg_vals	Get all valid values of arg bg.
bg_red	Set to red (crayon::bgRed).
bg_blu	Set to blue (crayon::bgBlue).
bg_cyn	Set to cyan (crayon::bgCyan).
bg_blk	Set to black (crayon::bgBlack).
bg_grn	Set to green (crayon::bgGreen).
bg_wht	Set to white (crayon::bgWhite).
bg_yel	Set to yellow (crayon::bgYellow).
bg_mag	Set to magenta (crayon::bgMagenta).
bg_def	Set to system default.
bg	Set to value of arg bg.

Valid values of bg are the following:

magenta	'm', 'mag', 'magenta'
default	'd', 'def', 'default'
yellow	'y', 'yel','ylw', 'yellow'
black	'k', 'blk', 'black'
white	'w', 'wht', 'white'
green	'g', 'grn', 'green'
blue	'b', 'blu', 'blue'
cyan	'c', 'cyn', 'cyan'
red	'r', 'red'

NOTE: Silver (grey) is not valid for background.

Foreground color functions

fg_vals	Get all valid values of fg (foreground text color).
fg_red	Set to red (crayon::red).
fg_blu	Set to red (crayon::blue).
fg_cyn	Set to red (crayon::cyan).
fg_blk	Set to red (crayon::black).
fg_grn	Set to red (crayon::green).
fg_wht	Set to red (crayon::white).
fg_yel	Set to red (crayon::yellow).
fg_mag	Set to red (crayon::magenta).
fg_gry	Set to silver (grey) (crayon::silver).
fg_sil	Set to silver (grey).
fg_slv	Set to silver (grey).
fg_def	Set to system default.
fg	Set to value of arg fg.

Valid values of fg are :

silver (grey)	's', 'sil', 'slv', 'silver', 'gry', 'gray', 'grey'
magenta	'm', 'mag', 'magenta'
default	'd', 'def', 'default'
yellow	'y', 'yel', 'ylw', 'yellow'
black	'k', 'blk', 'black'
white	'w', 'wht', 'white'
green	'g', 'grn', 'green'
blue	'b', 'blu', 'blue'
cyan	'c', 'cyn', 'cyan'
red	'r', 'red'

NOTE: Silver (grey) is only valid for foreground.

Style functions

st_vals	Get all valid values of arg st.
st_bld	Set to bold (crayon::bold).
st_pln	Set to plain (crayon::reset).
st_itl	Set to italic (crayon::italic).
st_und	Set to underline (crayon::italic).
st_def	Set to system default.
st	Set to value of arg st.

Valid values of st are:

underline	⁠'u', 'un', 'und', 'under', 'underline',⁠
	'underlined'
default	⁠'d', 'def', 'default'⁠
italic	⁠'i', 'it', 'itl', 'ital', 'italic',⁠
	⁠'italics', 'italicized', 'e', 'em',⁠
	⁠'emp', 'emph', 'emphasis', 'emphasized'⁠
plain	⁠'p', 'pl', 'pln', 'plain',  'r', 're',⁠
	⁠'res', 'reset'⁠
bold	⁠'b', 'bo', 'bld', 'bold', 'bolded', 's',⁠
	⁠'st', 'str', 'strong'⁠

Generic function

txt	Styles text using args st, bg, fg.

Examples

bg_vals()
bg_vals("k")
bg_vals("mag")
bg_vals("yellow")

fg_vals()
fg_vals("s")
fg_vals("blu")
fg_vals("white")

st_vals()
st_vals("b")
st_vals("itl")
st_vals("plain")
st_vals("underline")

## Not run: 
  ## because formatting doesn't show up in help viewer examples output

  egGrayons <- function() {
    egArg1 <- "Some "
    egArg2 <- c("text", " to display", "\nP.S. ")
    cat("\n", st_bld(egArg1, egArg2, "note"))
    cat("\n", st_def(egArg1, egArg2, "note"))
    cat("\n", st_itl(egArg1, egArg2, "note"))
    cat("\n", st_pln(egArg1, egArg2, "note"))
    cat("\n", st_und(egArg1, egArg2, "note"))
    cat("\n", st("u"        , egArg1, egArg2, "note"))
    cat("\n", st("itl"      , egArg1, egArg2, "note"))
    cat("\n", st("under"    , egArg1, egArg2, "note"))
    cat("\n", st_itl(st_und(egArg1, egArg2, "note")))
    cat("\n", st("underline", st("itl", egArg1, egArg2, "note")))
    cat("\n", fg_blk(egArg1, egArg2))
    cat("\n", fg_blu(egArg1, egArg2))
    cat("\n", fg_cyn(egArg1, egArg2))
    cat("\n", fg_def(egArg1, egArg2))
    cat("\n", fg_grn(egArg1, egArg2))
    cat("\n", fg_gry(egArg1, egArg2))
    cat("\n", fg_sil(egArg1, egArg2))
    cat("\n", fg_slv(egArg1, egArg2))
    cat("\n", fg_mag(egArg1, egArg2))
    cat("\n", fg_red(egArg1, egArg2))
    cat("\n", fg_wht(egArg1, egArg2))
    cat("\n", fg_yel(egArg1, egArg2))
    cat("\n", fg_def(egArg1, egArg2))
    cat("\n", fg("s", egArg1, egArg2, "note"))
    cat("\n", fg("sil", egArg1, egArg2, "note"))
    cat("\n", fg("grey", egArg1, egArg2, "note"))
    cat("\n", bg_blk(egArg1, egArg2, "note"))
    cat("\n", bg_blu(egArg1, egArg2, "note"))
    cat("\n", bg_cyn(egArg1, egArg2, "note"))
    cat("\n", bg_def(egArg1, egArg2, "note"))
    cat("\n", bg_grn(egArg1, egArg2, "note"))
    cat("\n", bg_mag(egArg1, egArg2, "note"))
    cat("\n", bg_red(egArg1, egArg2, "note"))
    cat("\n", bg_wht(egArg1, egArg2, "note"))
    cat("\n", bg_yel(egArg1, egArg2, "note"))
    cat("\n", bg_def(egArg1, egArg2, "note"))
    cat("\n", bg("y"     , egArg1, egArg2, "note"))
    cat("\n", bg("blu"   , egArg1, egArg2, "note"))
    cat("\n", bg("yellow", egArg1, egArg2, "note"))
    cat("\n", bg("y", fg("r", st("u", st("i", egArg1, egArg2, "note")))))
    cat("\n", txt(egArg1, egArg2, "note", bg = "blue", fg = "w", st = c("i", "under")))
  }
  egCrayons()

## End(Not run)

j-martineau/uj documentation built on Sept. 14, 2024, 4:40 a.m.