feat: response variable data

Author: aravindhebbali

NAMESPACE

@@ -97,6 +97,7 @@ export(ols_get_parameters)
 export(ols_get_predicted)
 export(ols_get_predictors)
 export(ols_get_residuals)
+export(ols_get_response)
 export(ols_get_sigma)
 export(ols_get_variables)
 export(ols_get_vcov)

R/ols-model-info.R

@@ -274,3 +274,21 @@ ols_get_parameters <- function(model) {
 ols_get_predictors <- function(model) {
   model$model[, -1]
 }
+
+#' Response variable data
+#' 
+#' Returns the values of the response variable of a model.
+#' 
+#' @param model An object of class \code{lm}.
+#'
+#' @return Values of the response variable.
+#'
+#' @examples
+#' model <- lm(mpg ~ wt + cyl + hp + disp + gear + drat, data = mtcars)
+#' ols_get_response(model)
+#'
+#' @export
+#'
+ols_get_response <- function(model) {
+  model$model[, 1]
+}

R/utils.R

@@ -98,9 +98,9 @@ ols_get_terms <- function(model) {
 #  model$model[, -1]
 #}
 
-ols_get_response <- function(model) {
-  model$model[, 1]
-}
+#ols_get_response <- function(model) {
+#  model$model[, 1]
+#}
 
 ols_get_call <- function(model) {
   model$call

man/ols_get_response.Rd

@@ -124,3 +124,10 @@ test_that("predictor data is returned", {
   got   <- names(ols_get_predictors(model))
   expect_equal(want, got)
 })
+
+test_that("response data is returned", {
+  model <- lm(mpg ~ disp + hp + wt, data = mtcars)
+  want  <- c(21.0, 21.0, 22.8, 21.4, 18.7, 18.1)
+  got   <- head(ols_get_response(model))
+  expect_equal(want, got)
+})