Value Formats — value_formats • rtables

Returns a matrix of formats for the cells in a table

Usage

value_formats(obj, default = obj_format(obj))

# S4 method for ANY
value_formats(obj, default = obj_format(obj))

# S4 method for TableRow
value_formats(obj, default = obj_format(obj))

# S4 method for LabelRow
value_formats(obj, default = obj_format(obj))

# S4 method for VTableTree
value_formats(obj, default = obj_format(obj))

Arguments

obj: A table or row object.
default: FormatSpec.

Value

Matrix (storage mode list) containing the effective format for each cell position in the table (including 'virtual' cells implied by label rows, whose formats are always NULL)

Examples


lyt <- basic_table() %>%
split_rows_by("RACE", split_fun = keep_split_levels(c("ASIAN", "WHITE"))) %>%
analyze("AGE")

tbl <- build_table(lyt, DM)
value_formats(tbl)
#>       all obs
#> ASIAN NULL   
#> Mean  "xx.xx"
#> WHITE NULL   
#> Mean  "xx.xx"