sprinkle_height {pixiedust} | R Documentation |
Adjust Table Cell Height
Description
Customize the height of a cell in a table. This may be done to improve the appearance of cells with long text.
Usage
sprinkle_height(
x,
rows = NULL,
cols = NULL,
height = NULL,
height_units = NULL,
part = c("body", "head", "foot", "interfoot", "table"),
fixed = FALSE,
recycle = c("none", "rows", "cols", "columns"),
...
)
## Default S3 method:
sprinkle_height(
x,
rows = NULL,
cols = NULL,
height = NULL,
height_units = NULL,
part = c("body", "head", "foot", "interfoot", "table"),
fixed = FALSE,
recycle = c("none", "rows", "cols", "columns"),
...
)
## S3 method for class 'dust_list'
sprinkle_height(
x,
rows = NULL,
cols = NULL,
height = NULL,
height_units = 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. |
height |
|
height_units |
|
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 HTML and LaTeX. All of the
height_units
values are recognized by HTML. For LaTeX, "px"
is converted to "pt"
.
Functional Requirements
Correctly reassigns the appropriate elements of
height
andheight_units
columns in the table part.Casts an error if
x
is not adust
object.Casts an error if
height
is not anumeric(1)
Casts an error if
height_units
is not acharacter(1)
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"
Cast an error if
recycle = "none"
andheight
does not have length 1.When
recycle = "none"
, quietly coerceheight_units
to just the first element given.
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
.