gtsummary (version 1.6.0)

as_flex_table: 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,
  strip_md_bold = NULL
)

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

return_calls

Logical. Default is FALSE. If TRUE, the calls are returned as a list of expressions.

strip_md_bold

DEPRECATED

Value

A flextable object

Experimental

The ftExtra package provides a function to recognize and print markdown syntax in flextable headers. To use this feature

• Install ftExtra v0.4.0 or greater

• Set options(gtsummary.use_ftExtra = TRUE) or the corresponding theme element

To "turn off" this feature, run as_flex_table(include = -ftExtra).

If you experience any issues using this feature, please file an issue at https://github.com/ddsjoberg/gtsummary/issues/new/choose.

Example Output

Example 1

See Also

Other gtsummary output types: as_gt(), as_hux_table(), as_kable_extra(), as_kable(), as_tibble.gtsummary()

Examples

# NOT RUN {
as_flex_table_ex1 <-
  trial %>%
  select(trt, age, grade) %>%
  tbl_summary(by = trt) %>%
  add_p() %>%
  as_flex_table()
# }