tests/testthat/test-check_convergence.R

In performance: Assessment of Regression Models Performance

skip_on_cran()

test_that("check_convergence", {
  skip_if_not_installed("lme4")

  data(cbpp, package = "lme4")
  set.seed(1)
  cbpp$x <- rnorm(nrow(cbpp))
  cbpp$x2 <- runif(nrow(cbpp))

  model <- suppressWarnings(lme4::glmer(
    cbind(incidence, size - incidence) ~ period + x + x2 + (1 + x | herd),
    data = cbpp,
    family = binomial()
  ))
  expect_true(check_convergence(model))
  expect_equal(
    check_convergence(model),
    structure(TRUE, gradient = NA_real_),
    tolerance = 1e-3
  )
  expect_warning(
    check_convergence(x = model),
    regex = "Argument `x` is deprecated",
    fixed = TRUE
  )
})

test_that("check_convergence", {
  skip_if_not_installed("lme4")

  data(sleepstudy, package = "lme4")
  model <- lme4::lmer(Reaction ~ Days + (1 + Days | Subject), data = sleepstudy)
  expect_true(check_convergence(model))
})


test_that("check_convergence, glmmTMB", {
  skip_if_not_installed("glmmTMB")
  data(iris)
  model <- suppressWarnings(glmmTMB::glmmTMB(
    Sepal.Length ~
      poly(Petal.Width, 4) * poly(Petal.Length, 4) + (1 + poly(Petal.Width, 4) | Species),
    data = iris
  ))
  expect_false(check_convergence(model))
  model <- suppressWarnings(glmmTMB::glmmTMB(
    Sepal.Length ~ Petal.Width + (1 | Species),
    data = iris
  ))
  expect_true(check_convergence(model))
})