R/summary_rfa.R

In milesdwilliams15/RFA: Estimate Average Treatment Effect via Random Forest Residualization

#' Return Summary Statistics for `rfa` object.
#'
#' The function returns the estimated coefficient, standard error,
#' t-statistic, p-value, confidence intervals, and random forest fit
#' performance for a `rfa` model object.
#'
#' @param model a `rfa` model object
#'
#' @return Returns summary statistics for the ATE obtained via the
#' RFA routine.
#'
#' @seealso The `rfa` function.
#'
#' @export
summary_rfa <- function(model){

  # Estimate SE, t-stat, and p-val
  out <- tidy(model$fit) %>%
    dplyr::select(-df, -outcome) %>%
    dplyr::mutate(
      OOB.response = c(NA, model$yrf$r.squared),
      OOB.predictor = c(NA, model$xrf$r.squared)
    )

  # Return output
  return(out)
}