huxtable: by_function – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

by_function

Map cell contents to cell properties using a function or scale

Description

This creates a simple wrapper around a function for use in map_xxx. Useful functions include scales and palettes from the scales package.

Usage

by_function(inner_fn, ignore_na = TRUE)

Arguments

`inner_fn`	A one-argument function which maps cell values to property values.
`ignore_na`	If `TRUE`, `NA` values in the result will be left unchanged from their previous values. Otherwise, `NA` normally resets to the default.

Details

The argument of inner_fn will be as.matrix(ht[row, col]). Be aware how matrix conversion affects the mode of cell data.

Value

A function for use in map_*** functions.

Examples

ht <- as_hux(matrix(runif(20), 5, 4))

map_background_color(ht,
      by_function(grey))

if (requireNamespace("scales")) {
  map_text_color(ht, by_function(
          scales::seq_gradient_pal()
        ))
}

huxtable

Easily Create and Style Tables for LaTeX, HTML and Other Formats

v5.3.0

MIT + file LICENSE

Authors

David Hugh-Jones [aut, cre]

Initial release