R: Sprinkle the Background Color of a Cell

sprinkle_bg {pixiedust}

R Documentation

Sprinkle the Background Color of a Cell

Description

Background colors may be used to highlight the contents of cells, rows, or columns. Most commonly, backgrounds are used to provide row discrimination; the sprinkle_bg_pattern function is better suited to that purpose.

Usage

sprinkle_bg(
  x,
  rows = NULL,
  cols = NULL,
  bg = "",
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

## Default S3 method:
sprinkle_bg(
  x,
  rows = NULL,
  cols = NULL,
  bg = "",
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

## S3 method for class 'dust_list'
sprinkle_bg(
  x,
  rows = NULL,
  cols = NULL,
  bg = "",
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

sprinkle_background(
  x,
  rows = NULL,
  cols = NULL,
  bg = "",
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

Arguments

`x`	An object of class `dust`
`rows`	Either a numeric vector of rows in the tabular object to be modified or an object of class `call`. When a `call`, generated by `quote(expression)`, the expression resolves to a logical vector the same length as the number of rows in the table. Sprinkles are applied to where the expression resolves to `TRUE`.
`cols`	Either a numeric vector of columns in the tabular object to be modified, or a character vector of column names. A mixture of character and numeric indices is permissible.
`bg`	`character(1)` A character string giving a color for the background of the chosen cells.
`part`	A character string denoting which part of the table to modify.
`fixed`	`logical(1)` indicating if the values in `rows` and `cols` should be read as fixed coordinate pairs. By default, sprinkles are applied at the intersection of `rows` and `cols`, meaning that the arguments do not have to share the same length. When `fixed = TRUE`, they must share the same length.
`recycle`	A `character` one that determines how sprinkles are managed when the sprinkle input doesn't match the length of the region to be sprinkled. By default, recycling is turned off. Recycling may be performed across rows first (left to right, top to bottom), or down columns first (top to bottom, left to right).
`...`	Additional arguments to pass to other methods. Currently ignored.

Details

Colors may be a dvips color name, or in the rgb(R, G, B), rgba(R, G, B, A), #RRGGBB, or #RRGGBBAA formats.

This sprinkle is ignored in console and markdown outputs. HTML output will accept any of the color formats and recognize transparency. LaTeX output will accept any of the color formats but ignore transparency.

As long as bg is required to be a character(1), the recycle argument is kind of useless. It is included to maintain consistency with the index_to_sprinkle function. Future development may permit a character vector of colors.

Functional Requirements

Correctly reassigns the appropriate elements bg column in the table part.
Casts an error if x is not a dust object.
Casts an error if bg is not a character(1)
Casts an error if bg is not a valid color format.
Casts an error if part is not one of "body", "head", "foot", or "interfoot"
Casts an error if fixed is not a logical(1)
Casts an error if recycle is not one of "none", "rows", or "cols"
Casts an error if recycle = "none" and bg does not have length 1.

The functional behavior of the fixed and recycle arguments is not tested for this function. It is tested and validated in the tests for index_to_sprinkle.

Author(s)

Benjamin Nutter