sprinkle_sanitize {pixiedust} | R Documentation |
Sanitize Characters for LaTeX Outputs
Description
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.
Usage
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"),
...
)
## Default S3 method:
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 class '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"),
...
)
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. |
sanitize |
|
sanitize_args |
A list of arguments to pass to
|
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
This sprinkle is only recognized by LaTeX output. See
latexTranslate
for more details.
Functional Requirements
Correctly reassigns the appropriate elements of
sanitize
andsanitize_args
columns in the table part.Casts an error if
x
is not adust
object.Casts an error if
sanitize
is not alogical(1)
Casts an error if
sanitize_args
is not alist
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"
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
.