R/slr.R

In ECO230/eco230r:

#' Generate output for a Simple Linear Regression
#'
#'This function performs a simple linear regression and returns reporting information on the model.
#'
#' @param x A formula dependent variable ~ independent variable.
#' @param y A data frame, necessary if data frame is not referenced in formula or piped in.
#'
#' @return A list of output for reporting $analysis_type, $results, $linear_regression_model, $predictors, $coefficients
#' @export
#'
#' @examples slr_results <- sales_data %>% slr(sales ~ adverts)
#' slr_results <- slr(sales ~ adverts, sales_data)
#' slr_results < slr(sales_data$sales ~ sales_data$adverts)
slr <- function(x, y = NULL) {

  fd <- is.formula(x) * is.data.frame(y)
  df <- is.data.frame(x) * is.formula(y)
  fn <- is.formula(x) * missing(y)

  if (fd) {
    formula <- x
    data <- y
    mf <- model.frame(formula,data)
  }
  else if (df) {
    formula <- y
    data <- x
    mf <- model.frame(formula,data)
  }
  else if (fn) {
    formula = x
    mf <- model.frame(formula)
  }

  #Build Model
  mod <- lm(formula = formula, data = data, na.action = na.exclude)

  #descriptives
  res_list <- report_lm(mod,deparse(formula))
  res_list
}