R/helpers-stanreg.R

In rdss: Companion Datasets and Functions for Research Design in the Social Sciences

#' Tidy results from a stanreg regression and exponentiate the estimated coefficient
#'
#' This function is deprecated. Please use the 'tidy' function from the 'broom.mixed' package.
#'
#' See https://book.declaredesign.org/choosing-an-answer-strategy.html#bayesian-formalizations
#'
#' @param x A stanreg fit from stan_glm
#' @param conf.int Logical indicating whether or not to include a confidence interval in the tidied output. Defaults to FALSE.
#' @param conf.level The confidence level to use for the confidence interval if conf.int = TRUE. Must be strictly greater than 0 and less than 1. Defaults to 0.95, which corresponds to a 95 percent confidence interval.
#' @param exponentiate Logical indicating whether or not to exponentiate the the coefficient estimates. Defaults to FALSE.
#' @param ... Other arguments to broom.mixed::tidy
#'
#' @return data.frame of results
#'
#' @export
tidy_stan <- function(x, conf.int = FALSE, conf.level = 0.95, exponentiate = FALSE, ...) {

  message("This function is deprecated. Please use the 'tidy' function from the 'broom.mixed' package.")

  if(!requireNamespace("broom.mixed")){
    message("The tidy_stan function requires the 'broom.mixed' package.")
    return(invisible())
  }

  ret <- broom.mixed::tidy(x, conf.int = conf.int, conf.level = conf.level, exponentiate = exponentiate, ...)

  ret
}