feat: model object info

Author: aravindhebbali

NAMESPACE

@@ -110,6 +110,7 @@ export(ols_hsp)
 export(ols_launch_app)
 export(ols_leverage)
 export(ols_mallows_cp)
+export(ols_model_info)
 export(ols_msep)
 export(ols_plot_added_variable)
 export(ols_plot_comp_plus_resid)

R/ols-model-info.R

@@ -369,3 +369,35 @@ ols_count_parameters <- function(model) {
 ols_has_intercept <- function(model) {
   as.logical(attr(model$terms, "intercept"))
 }
+
+#' Model object info
+#'
+#' Comprehensive information from model objects.
+#' 
+#' @param model An object of class \code{lm}.
+#'
+#' @return A list with information about model objects.
+#'
+#' @examples
+#' model <- lm(mpg ~ wt + cyl * hp * disp + gear * drat, data = mtcars)
+#' ols_model_info(model)
+#'
+#' @export
+#'
+ols_model_info <- function(model) {
+  return(
+    list(
+      call               = ols_get_call(model),
+      degrees_of_freedom = ols_get_df(model),
+      deviance           = ols_get_deviance(model),
+      formula            = ols_get_formula(model),
+      has_intercept      = ols_has_intercept(model),
+      interaction_terms  = ols_get_interaction_terms(model),
+      intercept_value    = ols_get_intercept(model),
+      obs                = ols_count_obs(model),
+      parameters         = ols_get_parameters(model),
+      sigma              = ols_get_sigma(model),
+      variables          = ols_get_variables(model)
+    )
+  )
+}

man/ols_model_info.Rd

@@ -146,6 +146,13 @@ test_that("number of observations is returned", {
   expect_equal(want, got)
 })
 
+test_that("number of parameters is returned", {
+  model <- lm(mpg ~ disp + hp + wt, data = mtcars)
+  want  <- 4
+  got   <- ols_count_parameters(model)
+  expect_equal(want, got)
+})
+
 test_that("model has intercept", {
   model <- lm(mpg ~ disp + hp + wt, data = mtcars)
   got   <- ols_has_intercept(model)
@@ -158,3 +165,11 @@ test_that("model has no intercept", {
   expect_false(got)
 })
 
+test_that("model info is correct", {
+  model <- lm(mpg ~ disp + hp + wt, data = mtcars)
+  got   <- ols_model_info(model)
+  expect_equal(got$degrees_of_freedom, 28)
+  expect_true(got$has_intercept)
+  expect_null(got$interaction_terms)
+  expect_equal(got$obs, 32)
+})