value_formats: Value formats

In rtables: Reporting Tables

Value formats

Description

Returns a matrix of formats for the cells in a table.

Usage

value_formats(obj, default = obj_format(obj))

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

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

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

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

Arguments

obj	(VTableTree or TableRow) a table or row object.
default	(string, function, or list) default format.

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).

See Also

table_shell() and table_shell_str() for information on the table format structure.

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)

rtables documentation built on Sept. 30, 2024, 9:32 a.m.