tests/testthat/test-ard_regression.R

In cardx: Extra Analysis Results Data Utilities

skip_if_not(is_pkg_installed(pkg = "broom.helpers"))

test_that("ard_regression() works", {
  withr::local_options(list(width = 90))

  expect_silent(
    ard <-
      lm(AGE ~ ARM, data = cards::ADSL) |>
      ard_regression(add_estimate_to_reference_rows = TRUE)
  )

  expect_snapshot(
    ard |>
      as.data.frame() |>
      dplyr::select(-context, -stat_label, -fmt_fun) |>
      dplyr::mutate(
        stat = lapply(stat, function(x) ifelse(is.numeric(x), cards::round5(x, 3), x))
      )
  )

  expect_equal(
    ard,
    ard_regression(
      x = cards::ADSL,
      formula = AGE ~ ARM,
      method = "lm"
    )
  )

  # checking non-syntactic names
  expect_equal(
    lm(AGE ~ `Treatment Arm`, data = cards::ADSL |> dplyr::rename(`Treatment Arm` = ARM)) |>
      ard_regression(add_estimate_to_reference_rows = TRUE) |>
      dplyr::pull(variable) |>
      unique(),
    "Treatment Arm"
  )
})

test_that("ard_regression() works specifying custom tidier", {
  skip_if_not(is_pkg_installed(pkg = c("lme4", "broom.mixed")))
  withr::local_options(list(width = 90))

  expect_snapshot(
    lme4::lmer(mpg ~ hp + (1 | cyl), data = mtcars) |>
      ard_regression(tidy_fun = broom.mixed::tidy) |>
      as.data.frame() |>
      dplyr::select(-context, -stat_label, -fmt_fun) |>
      dplyr::filter(map_lgl(stat, is.numeric)) |>
      dplyr::mutate(
        stat = lapply(stat, function(x) ifelse(is.numeric(x), cards::round5(x, 3), x))
      )
  )
})

test_that("ard_regression() does not produce `variable_level` column where not applicable", {
  expect_true(!"variable_level" %in% names(lm(mpg ~ hp, mtcars) |> ard_regression()))
})

test_that("ard_regression() warnings and errors return correctly", {
  skip_if_not(is_pkg_installed(pkg = "parameters"))
  # constructed a model where broom.helpers fails,
  # fall back method uses parameters which returns different messaging.
  mod <- lm(AGE ~ ARM, data = cards::ADSL)
  mod$coefficients <- NULL
  df <- mod |>
    ard_regression() |>
    as.data.frame()

  expect_false(is_empty(df$error))
  expect_true(is_empty(df$stat[[1]]))
})

test_that("ard_regression() follows ard structure", {
  expect_silent(
    lm(AGE ~ ARM, data = cards::ADSL) |>
      ard_regression(add_estimate_to_reference_rows = TRUE) |>
      cards::check_ard_structure(method = FALSE)
  )
})