tests/testthat/test-modify_footnote.R

In ddsjoberg/gtsummary: Presentation-Ready Data Summary and Analytic Result Tables

skip_on_cran()

test_that("modify_footnote works", {
  tbl_summary <-
    trial %>%
    dplyr::select(trt, age, grade) %>%
    tbl_summary(by = trt)

  expect_snapshot(
    tbl_summary %>%
      modify_footnote(
        update = starts_with("stat_") ~
          "median (IQR) for continuous variables; n (%) categorical variables"
      ) %>%
      as.data.frame()
  )

  expect_snapshot(
    tbl_summary %>%
      modify_footnote(
        label = "Variable Footnote",
        starts_with("stat_") ~
          "median (IQR) for continuous variables; n (%) categorical variables"
      ) %>%
      as.data.frame()
  )

  expect_snapshot(
    tbl_summary %>%
      modify_footnote(update = everything() ~ NA) %>%
      as.data.frame()
  )

  expect_equal(
    tbl_summary %>% utils::modifyList(val = list(call_list = NULL)),
    tbl_summary %>%
      modify_footnote(update = NULL) %>%
      utils::modifyList(val = list(call_list = NULL))
  )

  expect_snapshot(
    glm(response ~ age + grade, trial, family = binomial) %>%
      tbl_regression(exponentiate = TRUE) %>%
      modify_footnote(ci ~ "CI = Credible Interval", abbreviation = TRUE) %>%
      as.data.frame()
  )

  expect_true(
    tbl_summary %>%
      modify_footnote(everything() ~ NA) %>%
      purrr::pluck(
        "table_styling", "header",
        "footnote"
      ) %>%
      is.na() %>%
      all()
  )
})