R/glance_fun.R

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

#' Default glance function
#'
#' This is an S3 generic used as the default function in `add_glance*(glance_fun)`.
#' It's provided so various regression model classes can have their own default
#' functions for returning statistics.
#'
#' @param x (regression model)\cr
#'   a regression model object
#' @inheritParams rlang::args_dots_empty
#'
#' @return a function
#' @name glance_fun_s3
#' @keywords internal
#'
#' @examples
#' mod <- lm(age ~ trt, trial)
#'
#' glance_fun_s3(mod)
NULL

#' @name glance_fun_s3
#' @export
glance_fun_s3 <- function(x, ...) {
  UseMethod("glance_fun_s3")
}

#' @name glance_fun_s3
#' @export
glance_fun_s3.default <- function(x, ...) {
  check_pkg_installed("broom", reference_pkg = "gtsummary")
  check_dots_empty()
  broom::glance
}

#' @name glance_fun_s3
#' @export
glance_fun_s3.mira <- function(x, ...) {
  check_pkg_installed(c("broom",  "mice"), reference_pkg = "gtsummary")
  check_dots_empty()
  \(x) broom::glance(mice::pool(x))
}