Skip to contents

Modify table caption

Source: R/modify_caption.R
modify_caption.Rd

Captions are assigned based on output type.

  • gt::gt(caption=)

  • flextable::set_caption(caption=)

  • huxtable::set_caption(value=)

  • knitr::kable(caption=)

Usage

modify_caption(x, caption, text_interpret = c("md", "html"))

Arguments

x

(gtsummary)
A gtsummary object

caption

(string/character)
A string for the table caption/title. NOTE: The gt print engine supports a vector of captions. But not every print engine supports this feature, and for those outputs, only a string is accepted.

text_interpret

(string)
String indicates whether text will be interpreted with gt::md() or gt::html(). Must be "md" (default) or "html". Applies to tables printed with {gt}.

Value

Updated gtsummary object

Examples

trial |>
  tbl_summary(by = trt, include = c(marker, stage)) |>
  modify_caption(caption = "**Baseline Characteristics** N = {N}")



  
Baseline Characteristics N = 200
  
Characteristic
      Drug A

N = 981		
      Drug B

N = 1021		
    
Marker Level (ng/mL)
0.84 (0.23, 1.60)
0.52 (0.18, 1.21)
    Unknown
6
4
T Stage



    T1
28 (29%)
25 (25%)
    T2
25 (26%)
29 (28%)
    T3
22 (22%)
21 (21%)
    T4
23 (23%)
27 (26%)
1 Median (Q1, Q3); n (%)