palettes-options: Package options

In palettes: Methods for Colour Vectors and Colour Palettes

Package options

Description

Options that adjust the behaviour of the palettes package.

Details

These options can be set via options() and queried via getOption().

Options for the palettes package

palettes.print_symbol:

Character string setting the symbol used for colour previews. See list_colour_symbols() for a list of symbol choices. Defaults to "circle_small". Set to FALSE to disable printing symbols.

palettes.print_hex:

Logical setting whether to print hex codes in colour previews. Defaults to TRUE.

palettes.print_alpha:

Logical setting whether to print the hex code alpha channel in colour previews. Defaults to FALSE. Colours without an alpha channel will be assumed to be full opacity.

palettes.print_sep:

Character string to separate colours by in colour previews. Defaults to "".

palettes.print_width:

Integer setting the maximum number of colours on a line in colour previews. Defaults to 1.

palettes.print_index:

Logical setting whether to print the index of the first colour on each line in colour previews. Defaults to FALSE.

Note

To disable formatting in colour previews set both palettes.print_symbol and palettes.print_hex to FALSE.

Examples

options(
  palettes.print_symbol = "square",
  palettes.print_hex = FALSE,
  palettes.print_sep = " ",
  palettes.print_width = 3,
  palettes.print_index = TRUE
)
met_palettes$Cross

palettes documentation built on Sept. 11, 2024, 5:57 p.m.