colourise {testthat}R Documentation

Colourise text for display in the terminal.

Description

If R is not currently running in a system that supports terminal colours the text will be returned unchanged.

Usage

  colourise(text, fg = "black", bg = NULL)

Arguments

text

character vector

fg

foreground colour, defaults to white

bg

background colour, defaults to transparent

Details

Allowed colours are: black, blue, brown, cyan, dark gray, green, light blue, light cyan, light gray, light green, light purple, light red, purple, red, white, yellow

Examples

print(colourise("Red", "red"))
cat(colourise("Red", "red"), "\n")
cat(colourise("White on red", "white", "red"), "\n")

[Package testthat version 0.6 Index]