gtsummary (version 1.3.6)

theme_gtsummary: Available gtsummary themes

Description

experimental The following themes are available to use within the gtsummary package. Print theme elements with theme_gtsummary_journal(set_theme = FALSE) %>% print(). Review the themes vignette for details.

Usage

theme_gtsummary_journal(
  journal = c("jama", "nejm", "lancet"),
  set_theme = TRUE
)
theme_gtsummary_compact(set_theme = TRUE)
theme_gtsummary_printer(
  print_engine = c("gt", "kable", "kable_extra", "flextable", "huxtable", "tibble"),
  set_theme = TRUE
)
theme_gtsummary_language(
  language = c("de", "en", "es", "fr", "gu", "hi", "ja", "mr", "pt", "se", "zh-cn",
    "zh-tw"),
  decimal.mark = NULL,
  big.mark = NULL,
  iqr.sep = NULL,
  ci.sep = NULL,
  set_theme = TRUE
)
theme_gtsummary_continuous2(
  statistic = "{median} ({p25, {p75})",
  set_theme = TRUE
)
theme_gtsummary_mean_sd(set_theme = TRUE)

Arguments

journal

String indicating the journal theme to follow.

• "jama" Journal of the American Medical Association

• "nejm" New England Journal of Medicine

• "lancet" The Lancet

set_theme

Logical indicating whether to set the theme. Default is TRUE. When FALSE the named list of theme elements is returned invisibly

print_engine

String indicating the print method. Must be one of "gt", "kable", "kable_extra", "flextable", "tibble"#' @export

language

String indicating language. Must be one of "de" (German), "en" (English), "es" (Spanish), "fr" (French), "gu" (Gujarati), "hi" (Hindi), "ja" (Japanese), "mr" (Marathi), "pt" (Portuguese), "se" (Swedish), "zh-cn" (Chinese Simplified), "zh-tw" (Chinese Traditional)

If a language is missing a translation for a word or phrase, please feel free to reach out on GitHub with the translated text!

decimal.mark

The character to be used to indicate the numeric decimal point. Default is "." or getOption("OutDec")

big.mark

Character used between every 3 digits to separate hundreds/thousands/millions/etc. Default is ",", except when decimal.mark = "," when the default is a space.

iqr.sep

string indicating separator for the default IQR in tbl_summary(). If decimal.mark= is NULL, iqr.sep= is ", ". The comma separator, however, can look odd when decimal.mark = ",". In this case the argument will default to an en dash

ci.sep

string indicating separator for confidence intervals. If decimal.mark= is NULL, ci.sep= is ", ". The comma separator, however, can look odd when decimal.mark = ",". In this case the argument will default to an en dash

statistic

Default statistic continuous variables

Themes

• theme_gtsummary_journal(journal=)

  • "jama" The Journal of the American Medical Association

  • "nejm" The New England Journal of Medicine

  • "lancet" The Lancet

• theme_gtsummary_compact()

  • tables printed with gt, flextable, kableExtra, or huxtable will be compact with smaller font size and reduced cell padding

• theme_gtsummary_printer(print_engine=)

  • "gt" sets the gt package as the default print engine

  • "flextable" sets the flextable package as the default print engine

  • "huxtable" sets the huxtable package as the default print engine

  • "kable" sets the knitr::kable() function as the default print engine

  • "kable_extra" sets the kableExtra package as the default print engine

  • "tibble" returns output as tibble

• theme_gtsummary_continuous2()

  • Set all continuous variables to summary type "continuous2" by default

  • Use the statistic= argument to set the default continuous variable summary statistics

• theme_gtsummary_mean_sd()

  • Set default summary statistics to mean and standard deviation in tbl_summary()

  • Set default tests in add_p.tbl_summary() to t-tests and ANOVA

Use reset_gtsummary_theme() to restore the default settings

Review the themes vignette to create your own themes.

Example Output

Example

See Also

Themes vignette

set_gtsummary_theme(), reset_gtsummary_theme()

Examples

# NOT RUN {
# Setting JAMA theme for gtsummary
theme_gtsummary_journal("jama")
# Themes can be combined by including more than one
theme_gtsummary_compact()

set_gtsummary_theme_ex1 <-
  trial %>%
  select(age, grade, trt) %>%
  tbl_summary(by = trt) %>%
  add_stat_label() %>%
  as_gt()

# reset gtsummary themes
reset_gtsummary_theme()
# }