Package index • vlightr

Highlight constructors

highlight() hl() highlight_mult() hl_mult() highlight_case() hl_case(): Conditionally format a vector

Temporary highlight constructors

templight() tl() templight_mult() tl_mult() templight_case() tl_case(): Conditionally format a vector by location

Highlighters

highlighter() highlighter_mult() highlighter_case(): Generate a re-usable highlight function

templighter() templighter_mult() templighter_case(): Make a temporary highlighter

as_highlighter(): Convert a highlighted vector into a highlighter

Accessors

tests() `tests<-`(): Get or set the test functions of a highlight or highlighter

formatters() `formatters<-`(): Get or set the formatter functions of a highlight or highlighter

highlight_functions() `highlight_functions<-`(): Get or set the test and formatter functions of a highlight or highlighter

Highlight, Un-light, Re-light

un_highlight() ul(): Unclass a highlighted vector

re_highlight() rl(): Restore a highlighted vector's formatting

`%hl>%`: Highlight pipe

Stylers

background() bg() color() colour() style() wrap() label(): Generate a formatter function to style text

Predicates

is_highlightable(): Test if the object can be highlighted

is_highlight(): Test if the object is a highlight

is_highlight_case(): Test if the object is a highlight-case vector

is_templight(): Test if the object is a temp-light vector

is_templight_case(): Test if the object is a temp-light-case vector

is_highlighter() is_highlighter_case(): Test if the object is a highlighter

is_templighter(): Test if the object is a temp-lighter function

is_templighter_case(): Test if the object is a temp-lighter function

Miscellaneous

true(): Return the value TRUE

false(): Return the value FALSE

highlight_lambda(): Convert a one-sided formula to a function