as_flex_table {gtsummary} | R Documentation |
Convert gtsummary object to a flextable object
Description
Function converts a gtsummary object to a flextable object. A user can use this function if they wish to add customized formatting available via the flextable functions. The flextable output is particularly useful when combined with R markdown with Word output, since the gt package does not support Word.
Usage
as_flex_table(x, include = everything(), return_calls = FALSE, ...)
Arguments
x |
Object created by a function from the gtsummary package (e.g. tbl_summary or tbl_regression) |
include |
Commands to include in output. Input may be a vector of
quoted or unquoted names. tidyselect and gtsummary select helper
functions are also accepted.
Default is |
return_calls |
Logical. Default is |
... |
Not used |
Details
The as_flex_table()
function supports bold and italic markdown syntax in column headers
and spanning headers ('**'
and '_'
only).
Text wrapped in double stars ('**bold**'
) will be made bold, and text between single
underscores ('_italic_'
) will be made italic.
No other markdown syntax is supported and the double-star and underscore cannot be combined.
To further style your table, you may convert the table to flextable with
as_flex_table()
, then utilize any of the flextable functions.
Value
A flextable object
Example Output
Example 1
Author(s)
Daniel D. Sjoberg
See Also
Other gtsummary output types:
as_gt()
,
as_hux_table()
,
as_kable_extra()
,
as_kable()
,
as_tibble.gtsummary()
Examples
as_flex_table_ex1 <-
trial %>%
select(trt, age, grade) %>%
tbl_summary(by = trt) %>%
add_p() %>%
as_flex_table()