feat: count obs and parameters

Author: aravindhebbali

NAMESPACE

@@ -84,6 +84,8 @@ export(ols_aic)
 export(ols_apc)
 export(ols_coll_diag)
 export(ols_correlations)
+export(ols_count_obs)
+export(ols_count_parameters)
 export(ols_eigen_cindex)
 export(ols_fpe)
 export(ols_get_call)
@@ -94,7 +96,6 @@ export(ols_get_formula)
 export(ols_get_interaction_terms)
 export(ols_get_intercept)
 export(ols_get_model_matrix)
-export(ols_get_obs)
 export(ols_get_parameters)
 export(ols_get_predicted)
 export(ols_get_predictors)

R/ols-model-info.R

@@ -323,14 +323,32 @@ ols_get_call <- function(model) {
 #'
 #' @examples
 #' model <- lm(mpg ~ wt + cyl + hp + disp + gear + drat, data = mtcars)
-#' ols_get_obs(model)
+#' ols_count_obs(model)
 #'
 #' @export
 #'
-ols_get_obs <- function(model) {
+ols_count_obs <- function(model) {
   nrow(model$model)
 }
 
+#' Parameters count
+#'
+#' Returns the number of parameters from a model. 
+#' 
+#' @param model An object of class \code{lm}.
+#'
+#' @return Number of parameters.
+#'
+#' @examples
+#' model <- lm(mpg ~ wt + cyl + hp + disp + gear + drat, data = mtcars)
+#' ols_count_parameters(model)
+#'
+#' @export
+#'
+ols_count_parameters <- function(model) {
+  nrow(ols_get_parameters(model))
+}
+
 #' Model intercept check 
 #' 
 #' Checks if model has an intercept. 

man/ols_get_obs.Rd man/ols_count_obs.Rdman/ols_get_obs.Rd renamed to man/ols_count_obs.Rd

@@ -142,7 +142,7 @@ test_that("model call is returned", {
 test_that("number of observations is returned", {
   model <- lm(mpg ~ disp + hp + wt, data = mtcars)
   want  <- 32
-  got   <- ols_get_obs(model)
+  got   <- ols_count_obs(model)
   expect_equal(want, got)
 })
 
@@ -157,3 +157,4 @@ test_that("model has no intercept", {
   got   <- ols_has_intercept(model)
   expect_false(got)
 })
+