gtsummary (version 1.5.1)

as_kable: Convert gtsummary object to a kable object

Description

Function converts a gtsummary object to a knitr_kable object. This function may be used in the background when the tables are printed or knitted.

Output from knitr::kable is less full featured compared to summary tables produced with gt. For example, kable summary tables do not include indentation, footnotes, or spanning header rows.

Usage

as_kable(
  x,
  include = everything(),
  return_calls = FALSE,
  exclude = NULL,
  fmt_missing = TRUE,
  ...
)

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.

exclude

DEPRECATED

fmt_missing

Logical argument adding the missing value formats.

...

Additional arguments passed to knitr::kable

Value

A knitr_kable object

Details

Tip: To better distinguish variable labels and level labels when indenting is not supported, try bold_labels() or italicize_levels().

See Also

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

Examples

# NOT RUN {
trial %>%
  tbl_summary(by = trt) %>%
  bold_labels() %>%
  as_kable()
# }