R/report_b.R

In durkeepk/report: Automate Reporting of Common Statistical Analyses

#' Generate an in-text report of regression coeffiecients
#'
#' @param coefficient object containing regression coefficient to report
#' @param format How should the output be formatted? Available options are:
#' \code{"plain"}, \code{"latex"}, \code{"rmarkdown"}
#' @param inline Should non-plain results be formatted for inline (\code{TRUE})
#' or for copy-pasting (\code{FALSE})?
#' (default is \code{TRUE})
#' @param standardize is the coefficient undstandardized [F] or standardized [T]
#' @return unstandardized or standardized regression coefficient
#' rounded to three decimal places (e.g., b = .123, beta = .123).
#' @examples
#' x <- c(1:25)
#' y = c(1, 1, 2, 3, 4, 5, 6, 2, 4, 6, 7, 2, 7, 3, 1, 1, 1, 3, 4, 6, 7, 7, 1, 4, 1)
#' model <- lm(y ~ x)
#' coef <- summary(model)$coefficients[2, 1]
#' report_b(coef)
#' @export




report_b <- function(coefficient = NULL,
                     format = 'rmarkdown',
                     inline = T,
                     standardize = F) {

    if (format != 'plain') {
      if (standardize == F) {
        bval <- sub("^(-?)0.", "\\1.", sprintf("%.3f", coefficient))
        b_report <- paste("$\\textit{b}$ =", bval)
      }
      if (standardize == T) {
        bval <- sub("^(-?)0.", "\\1.", sprintf("%.3f", coefficient))
        b_report <- paste("$\\beta$", " = ", bval, sep = "")
      }
    }
    if (format == 'plain') {
      if (standardize == F) {
        bval <- sub("^(-?)0.", "\\1.", sprintf("%.3f", coefficient))
        b_report <- paste("b =", bval)
      }
      if (standardize == T) {
        bval <- sub("^(-?)0.", "\\1.", sprintf("%.3f", coefficient))
        b_report <- paste("beta", " = ", bval, sep = "")
      }
    }
    # return conditions
    if (inline == F){
      return(cat(b_report))
    }
    if (format == 'rmarkdown'){
      return(noquote(b_report))
    }
    if (format != 'rmarkdown'){
      return(cat(b_report))
    }
}