R/info.R

In Rkabacoff/qacReg: Multiple Regression and Logistic Regression

#' @title Extended Model Summary
#' @description
#' Extended summary information for a model fit. Currently linear and logistic
#' regression models are supported.
#'
#' @details
#' \code{info} is a generic S3 function providing detailed model information.
#' The goal is to provide more extensive information than currently
#' produced by \code{\link{summary}}. See the related methods for
#' details.
#'
#' @seealso
#' \code{\link{info.lm}}, \code{\link{info.glm}}.
#'
#' @param x an object of type \code{lm} or \code{glm}. If \code{glm}, then
#' \code{family} must be \code{binomial}.
#'
#' @return A \code{list} produced by \code{\link{info.lm}} or
#' \code{\link{info.glm}}.
#' @export
#'
#' @examples
#' #######################
#' # multiple regression #
#' #######################
#' fit <- lm(mpg ~ hp + wt + accel + origin, data = auto_mpg)
#' info(fit)
#'
#' #######################
#' # logistic regression #
#' #######################
#' fit2 <- glm(caesarian ~ age + bp + delivery.time, family = binomial, data = caesarian)
#' info(fit2)
info <- function(x){
  UseMethod("info")
}