
Last chance! 50% off unlimited learning
Sale ends in
Every layout must start with a basic table.
basic_table(
title = "",
subtitles = character(),
main_footer = character(),
prov_footer = character(),
show_colcounts = NA,
colcount_format = "(N=xx)",
header_section_div = NA_character_,
top_level_section_div = NA_character_,
inset = 0L
)
A PreDataTableLayouts
object suitable for passing to further layouting functions, and to build_table()
.
(string
)
single string to use as main title (formatters::main_title()
). Ignored for subtables.
(character
)
a vector of strings to use as subtitles (formatters::subtitles()
), where every
element is printed on a separate line. Ignored for subtables.
(character
)
a vector of strings to use as main global (non-referential) footer materials
(formatters::main_footer()
), where every element is printed on a separate line.
(character
)
a vector of strings to use as provenance-related global footer materials
(formatters::prov_footer()
), where every element is printed on a separate line.
(logical(1)
)
Indicates whether the lowest level of
applied to data. NA
, the default, indicates that the show_colcounts
argument(s) passed to the relevant calls to split_cols_by*
functions. Non-missing values will override the behavior specified in
column splitting layout instructions which create the lowest level, or
leaf, columns.
(string
)
format for use when displaying the column counts. Must be 1d, or 2d
where one component is a percent. This will also apply to any displayed higher
level column counts where an explicit format was not specified. Defaults to "(N=xx)"
. See Details below.
(string
)
string which will be used to divide the header from the table. See
header_section_div()
for the associated getter and setter. Please consider changing last element of
section_div()
when concatenating tables that require a divider between them.
(character(1)
)
if assigned a single character, the first (top level) split
or division of the table will be highlighted by a line made of that character. See section_div for more
information.
(numeric(1)
)
number of spaces to inset the table header, table body, referential footnotes, and
main_footer, as compared to alignment of title, subtitle, and provenance footer. Defaults to 0 (no inset).
colcount_format
is ignored if show_colcounts
is FALSE
(the default). When show_colcounts
is TRUE
,
and colcount_format
is 2-dimensional with a percent component, the value component for the percent is always
populated with 1
(i.e. 100%). 1d formats are used to render the counts exactly as they normally would be,
while 2d formats which don't include a percent, and all 3d formats result in an error. Formats in the form of
functions are not supported for colcount
format. See formatters::list_valid_format_labels()
for the list
of valid format labels to select from.
lyt <- basic_table() %>%
analyze("AGE", afun = mean)
tbl <- build_table(lyt, DM)
tbl
lyt2 <- basic_table(
title = "Title of table",
subtitles = c("a number", "of subtitles"),
main_footer = "test footer",
prov_footer = paste(
"test.R program, executed at",
Sys.time()
)
) %>%
split_cols_by("ARM") %>%
analyze("AGE", mean)
tbl2 <- build_table(lyt2, DM)
tbl2
lyt3 <- basic_table(
show_colcounts = TRUE,
colcount_format = "xx. (xx.%)"
) %>%
split_cols_by("ARM")
Run the code above in your browser using DataLab