Constructor for Cell Value
Usage
CellValue(
val,
format = NULL,
colspan = 1L,
label = NULL,
indent_mod = NULL,
footnotes = NULL,
align = NULL,
format_na_str = NULL,
stat_names = NA_character_
)
Arguments
- val
(
ANY
)
value in the cell exactly as it should be passed to a formatter or returned when extracted.- format
(
string
,function
, orlist
)
format associated with this split. Formats can be declared via strings ("xx.x"
) or function. In cases such asanalyze
calls, they can be character vectors or lists of functions. Seeformatters::list_valid_format_labels()
for a list of all available format strings.- colspan
(
integer(1)
)
column span value.- label
(
string
)
a label (not to be confused with the name) for the object/structure.- indent_mod
(
numeric
)
modifier for the default indent position for the structure created by this function (subtable, content table, or row) and all of that structure's children. Defaults to 0, which corresponds to the unmodified default behavior.- footnotes
(
list
orNULL
)
referential footnote messages for the cell.- align
(
string
orNULL
)
alignment the value should be rendered with. Defaults to"center"
ifNULL
is used. Seeformatters::list_valid_aligns()
for all currently supported alignments.- format_na_str
(
string
)
string which should be displayed when formatted if this cell's value(s) are allNA
.- stat_names
(
character
orNA
)
names for the statistics in the cell. It can be a vector of strings. IfNA
, statistic names are not specified.