R/grab_resids.R

Defines functions grab_resids

Documented in grab_resids

#' @title Grab the residuals
#' @description This function grabs the residuals of a linear model.
#' @param lm_obj the linear model created by the lm function
#' @export
#' @examples
#' library(palmerpenguins)
#' fit <- lm (bill_length_mm ~., data = penguins[,-8])
#' grab_resids(fit)

grab_resids <- function(lm_obj) {
  lm_obj$residuals
}
kimgannon/bis557 documentation built on Nov. 25, 2020, 7:09 a.m.