feat: model call

Author: aravindhebbali

NAMESPACE

@@ -86,6 +86,7 @@ export(ols_coll_diag)
 export(ols_correlations)
 export(ols_eigen_cindex)
 export(ols_fpe)
+export(ols_get_call)
 export(ols_get_data)
 export(ols_get_deviance)
 export(ols_get_df)

R/ols-model-info.R

@@ -292,3 +292,21 @@ ols_get_predictors <- function(model) {
 ols_get_response <- function(model) {
   model$model[, 1]
 }
+
+#' Model function call 
+#' 
+#' Returns the model's function call. 
+#' 
+#' @param model An object of class \code{lm}.
+#'
+#' @return Model's function call. 
+#'
+#' @examples
+#' model <- lm(mpg ~ wt + cyl + hp + disp + gear + drat, data = mtcars)
+#' ols_get_call(model)
+#'
+#' @export
+#'
+ols_get_call <- function(model) {
+  model$call
+}

R/utils.R

@@ -94,18 +94,6 @@ ols_get_terms <- function(model) {
   attr(model$terms, 'term.label')
 }
 
-#ols_get_predictors <- function(model) {
-#  model$model[, -1]
-#}
-
-#ols_get_response <- function(model) {
-#  model$model[, 1]
-#}
-
-ols_get_call <- function(model) {
-  model$call
-}
-
 ols_get_obs <- function(model) {
   nrow(model$model)
 }

man/ols_get_call.Rd

@@ -131,3 +131,10 @@ test_that("response data is returned", {
   got   <- head(ols_get_response(model))
   expect_equal(want, got)
 })
+
+test_that("model call is returned", {
+  model <- lm(mpg ~ disp + hp + wt, data = mtcars)
+  want  <- as.call(lm(mpg ~ disp + hp + wt, data = mtcars)$call)
+  got   <- ols_get_call(model)
+  expect_equal(want, got)
+})