R/regression_coeff.R

In dr-JT/regressionoutput: Create nice looking regression tables in RMarkdown documents

#' Regression Coefficients
#'
#' Displays a table for regression coefficients.
#'      Multiple models can be added (x, y, and z).
#' @param x a model object
#' @param y a model object
#' @param z a model object
#' @param ci display unstandardized confidence intervals? default = TRUE
#' @param se display standard errors? default = TRUE
#' @export
#'

regression_coeff <- function(x, y = NULL, z = NULL,
                             ci = TRUE, se = TRUE) {
  table <- get_coeff(x)
  table <- dplyr::mutate(table, Model = "H1")
  x_formula <- insight::find_formula(x)$conditional
  x_n <- insight::model_info(x)$n_obs
  dv <- insight::find_response(x)
  x_rows <- nrow(table)
  if (!is.null(y)) {
    y_table <- get_coeff(y)
    y_table <- dplyr::mutate(y_table, Model = "H2")
    y_formula <- insight::find_formula(y)$conditional
    y_n <- insight::model_info(y)$n_obs
    y_rows <- nrow(y_table)
    table <- dplyr::bind_rows(table, y_table)
    }
  if (!is.null(z)) {
    z_table <- get_coeff(z)
    z_table <- dplyr::mutate(z_table, Model = "H3")
    z_formula <- insight::find_formula(z)$conditional
    z_n <- insight::model_info(z)$n_obs
    z_rows <- nrow(z_table)
    table <- dplyr::bind_rows(table, z_table)
  }

  table <- dplyr::relocate(table, Model, .befor = Term)

  table <- dplyr::mutate(table,
                         Lower.CI_unstd = round(Lower.CI_unstd, 3),
                         Upper.CI_unstd = round(Upper.CI_unstd, 3),
                         Lower.CI = round(Lower.CI, 3),
                         Upper.CI = round(Upper.CI, 3))

  table <- tidyr::unite(table, "CI_unstd",
                        c("Lower.CI_unstd", "Upper.CI_unstd"), sep = " - ")

  table <- tidyr::unite(table, "CI",
                        c("Lower.CI", "Upper.CI"), sep = " - ")

  if (ci == FALSE) {
    table <- dplyr::select(table, -CI_unstd)
    if (se == FALSE) {
      header_names <- c("Model", "Term", "b", "B",
                        "95% CI", "t", "p")
      table <- dplyr::select(table, -SE, -SE_B)
      table <- knitr::kable(table, digits = 3, format = "html",
                            caption = paste("Regression Coefficients: ",
                                            dv, sep = ""),
                            row.names = FALSE,
                            col.names = header_names,
                            align = c("l", "l", rep("c", 5)))
      table <- kableExtra::kable_classic(table, position = "left")
      table <- kableExtra::kable_styling(table, full_width = FALSE,
                                         position = "left")
      table <- kableExtra::row_spec(table, 0, bold = TRUE)
      table <- kableExtra::add_header_above(table, c(" ", " ", "Unstandardized" = 1,
                                                     "Standardized" = 2,
                                                     " ", " "), bold = TRUE)
      table <- kableExtra::collapse_rows(table, columns = 1, valign = "top")
    } else {
      header_names <- c("Model", "Term", "b", "SE", "B", "SE",
                        "95% CI", "t", "p")
      table <- knitr::kable(table, digits = 3, format = "html",
                            caption = paste("Regression Coefficients: ",
                                            dv, sep = ""),
                            row.names = FALSE,
                            col.names = header_names,
                            align = c("l", "l", rep("c", 7)))
      table <- kableExtra::kable_classic(table, position = "left")
      table <- kableExtra::kable_styling(table, full_width = FALSE,
                                         position = "left")
      table <- kableExtra::row_spec(table, 0, bold = TRUE)
      table <- kableExtra::add_header_above(table, c(" ", " ", "Unstandardized" = 2,
                                                     "Standardized" = 3,
                                                     " ", " "), bold = TRUE)
      table <- kableExtra::collapse_rows(table, columns = 1, valign = "top")
    }
  } else {
    if (se == FALSE) {
      header_names <- c("Model", "Term", "b", "95% CI", "B",
                        "95% CI", "t", "p")
      table <- dplyr::select(table, -SE, -SE_B)
      table <- knitr::kable(table, digits = 3, format = "html",
                            caption = paste("Regression Coefficients: ",
                                            dv, sep = ""),
                            row.names = FALSE,
                            col.names = header_names,
                            align = c("l", "l", rep("c", 6)))
      table <- kableExtra::kable_classic(table, position = "left")
      table <- kableExtra::kable_styling(table, full_width = FALSE,
                                         position = "left")
      table <- kableExtra::row_spec(table, 0, bold = TRUE)
      table <- kableExtra::add_header_above(table, c(" ", " ", "Unstandardized" = 2,
                                                     "Standardized" = 2,
                                                     " ", " "), bold = TRUE)
      table <- kableExtra::collapse_rows(table, columns = 1, valign = "top")
    } else {
      header_names <- c("Model", "Term", "b", "SE", "95% CI",
                        "B", "SE", "95% CI", "t", "p")
      table <- knitr::kable(table, digits = 3, format = "html",
                            caption = paste("Regression Coefficients: ",
                                            dv, sep = ""),
                            row.names = FALSE,
                            col.names = header_names,
                            align = c("l", "l", rep("c", 8)))
      table <- kableExtra::kable_classic(table, position = "left")
      table <- kableExtra::kable_styling(table, full_width = FALSE,
                                         position = "left")
      table <- kableExtra::row_spec(table, 0, bold = TRUE)
      table <- kableExtra::add_header_above(table, c(" ", " ", "Unstandardized" = 3,
                                                     "Standardized" = 3,
                                                     " ", " "), bold = TRUE)
      table <- kableExtra::collapse_rows(table, columns = 1, valign = "top")
    }
  }

  if (is.null(y) & is.null(z)) {
    table <- kableExtra::footnote(table,
                                  number = paste("<small>", "H1: ", deparse(x_formula),
                                                 "; N = ", x_n, "</small>", sep = ""),
                                  escape = FALSE)
  } else if (!is.null(y) & is.null(z)) {
    table <- kableExtra::footnote(table,
                                  number = c(paste("<small>", "H1: ", deparse(x_formula),
                                                   "; N = ", x_n, "</small>", sep = ""),
                                             paste("<small>", "H2: ", deparse(y_formula),
                                                   "; N = ", y_n, "</small>", sep = "")),
                                  escape = FALSE)
  } else {
    table <- kableExtra::footnote(table,
                                  number = c(paste("<small>", "H1: ", deparse(x_formula),
                                                   "; N = ", x_n, "</small>", sep = ""),
                                             paste("<small>", "H2: ", deparse(y_formula),
                                                   "; N = ", y_n, "</small>", sep = ""),
                                             paste("<small>", "H3: ", deparse(z_formula),
                                                   "; N = ", z_n, "</small>", sep = "")),
                                  escape = FALSE)
  }

  return(table)
}