Create a set of options

Create a set of options

hl_opts(
  na = getOption("HL_NA", "NA"),
  full_colour = getOption("HL_FULL_COLOUR", FALSE),
  text_mode = getOption("HL_TEXT_MODE", "contrast"),
  text_contrast = getOption("HL_TEXT_CONTRAST", 1)
)

Arguments

na

Character string to display for NA values. Default 'NA'

full_colour

Use 24bit ANSI escape codes? default: FALSE - use 8bit colour. Note: RStudio only supports 8 bit ANSI output (24bit ANSI is rendered invisibly in Rstudio). For 24bit colour output, try R in the terminal e.g. 'iTerm' on OSX.

text_mode

How to handle text if no text colour has been explicitly specified by the user.

contrast

(default) automatically select a contrasting colour for enhanced readability.

asis

render text in the default text colour for the output device, unless the user has already specified a text colour at this location

remove

remove all text without a user-defined colour

text_contrast

When text_mode='contrast' this numeric value in range [0, 1] adjusts the visibility. Default: 1 (high contrast)

Examples

# Generate a standard set of options
hl_opts()
#> $na
#> [1] "NA"
#> 
#> $full_colour
#> [1] FALSE
#> 
#> $text_mode
#> [1] "contrast"
#> 
#> $text_contrast
#> [1] 1
#>