sprinkle_discrete: Change Color Features by Discrete Values

Description Usage Arguments Details Functional Requirements See Also

View source: R/sprinkle_discrete.R

Description

Distinct values within a range will be assigned a color and the designated attribute of the table will be modified accordingly.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
sprinkle_discrete(
  x,
  rows = NULL,
  cols = NULL,
  discrete = "bg",
  discrete_colors = getOption("pixie_discrete_pal", NULL),
  part = c("body", "head", "foot", "interfoot", "table"),
  fixed = FALSE,
  recycle = c("none", "rows", "cols", "columns"),
  ...
)

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

## S3 method for class 'dust_list'
sprinkle_discrete(
  x,
  rows = NULL,
  cols = NULL,
  discrete = "bg",
  discrete_colors = getOption("pixie_discrete_pal", NULL),
  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.

discrete

character. A subset of c("bg", "font", "font_color", "border", "left_border", "top_border", "right_border", "bottom_border").

discrete_colors

character. Gives the color palette to be used. Each value must be a valid color. Defaults to evenly spaced colors over the color space.

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

This sprinkle is only recognized by HTML and LaTeX. All of the height_units values are recognized by HTML. For LaTeX, "px" is converted to "pt".

"font" and "font_color" both change the font color.

"border" is a shortcut to specify all borders.

Functional Requirements

  1. Correctly reassigns the appropriate elements of the bg, font_color, left_border, top_border, right_border, or bottom_border column in the table part.

  2. Casts an error if x is not a dust object.

  3. Casts an error if discrete is not a subset of c("bg", "font", "font_color", "border", "left_border", "right_border", "top_border", "bottom_border")

  4. Casts an error if discrete_colors is not a character value.

  5. Casts an error if any value of discrete_colors is not a recognized color value.

  6. Casts an error if part is not one of "body", "head", "foot", or "interfoot"

  7. Casts an error if fixed is not a logical(1)

  8. Casts an error if recycle is not one of "none", "rows", or "cols"

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.

See Also

sprinkle, index_to_sprinkle


pixiedust documentation built on Jan. 16, 2021, 5:25 p.m.