Certain characters in LaTeX code need to be escaped to
prevent errors during processing. For example, % is the
comment character in LaTeX, and needs to be escaped in
order to render correctly.
sprinkle_sanitize(x, rows = NULL, cols = NULL, sanitize = NULL,
sanitize_args = NULL, part = c("body", "head", "foot", "interfoot",
"table"), fixed = FALSE, recycle = c("none", "rows", "cols", "columns"),
...)# S3 method for default
sprinkle_sanitize(x, rows = NULL, cols = NULL,
sanitize = NULL, sanitize_args = NULL, part = c("body", "head", "foot",
"interfoot", "table"), fixed = FALSE, recycle = c("none", "rows", "cols",
"columns"), ...)
# S3 method for dust_list
sprinkle_sanitize(x, rows = NULL, cols = NULL,
sanitize = NULL, sanitize_args = NULL, part = c("body", "head", "foot",
"interfoot", "table"), fixed = FALSE, recycle = c("none", "rows", "cols",
"columns"), ...)
An object of class dust
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.
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.
logical(1). Should the code for the cell be sanitized.
A list of arguments to pass to
Hmisc::latexTranslate
A character string denoting which part of the table to modify.
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.
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.
Correctly reassigns the appropriate elements of sanitize
and sanitize_args columns in the table part.
Casts an error if x is not a dust object.
Casts an error if sanitize is not a logical(1)
Casts an error if sanitize_args is not a list
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"
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.
This sprinkle is only recognized by LaTeX output. See
latexTranslate for more details.