sprinkle_fn {pixiedust} | R Documentation |
Apply a function to a selection of cells
Description
The pre-defined sprinkles do not always provide the desired impact on the tables. Applying a function allows for highly customized output without having to pre-process that data frame.
Usage
sprinkle_fn(
x,
rows = NULL,
cols = NULL,
fn = NULL,
part = c("body", "head", "foot", "interfoot", "table"),
fixed = FALSE,
recycle = c("none", "rows", "cols"),
...
)
## Default S3 method:
sprinkle_fn(
x,
rows = NULL,
cols = NULL,
fn = NULL,
part = c("body", "head", "foot", "interfoot", "table"),
fixed = FALSE,
recycle = c("none", "rows", "cols", "columns"),
...
)
## S3 method for class 'dust_list'
sprinkle_fn(
x,
rows = NULL,
cols = NULL,
fn = NULL,
part = c("body", "head", "foot", "interfoot", "table"),
fixed = FALSE,
recycle = c("none", "rows", "cols", "columns"),
...
)
Arguments
x |
An object of class |
rows |
Either a numeric vector of rows in the tabular object to be
modified or an object of class |
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. |
fn |
An object of class |
part |
A character string denoting which part of the table to modify. |
fixed |
|
recycle |
A |
... |
Additional arguments to pass to other methods. Currently ignored. |
Details
dust
objects transform tabular objects so that each cell
in the table comprises one row in the data frame of cell attributes.
The function to be applied needs to act on the value
column of
that data frame.
Functional Requirements
Correctly reassigns the appropriate elements
fn
column in the table part.Casts an error if
x
is not adust
object.Casts an error if
fn
is not acall
object.Casts an error if
part
is not one of"body"
,"head"
,"foot"
, or"interfoot"
Casts an error if
fixed
is not alogical(1)
Casts an error if
recycle
is not one of"none"
,"rows"
, or"cols"
Author(s)
Benjamin Nutter