R/descriptives_table.R

In dr-JT/resultsoutput: Get full output from statistical models in nice looking tables

#' Descriptive Statistics Table
#'
#' This function will display a table of descriptive statistics
#' @param x dataframe
#' @param digits How many decimal places to round to? Default is 3.
#' @export
#'

descriptives_table <- function(x, digits = 2) {
  col_order <- colnames(x)
  x <- tidyr::gather(x, "Variable", "value")
  x <- dplyr::group_by(x, Variable)
  table <- dplyr::summarise(x,
                            n = length(which(!is.na(value))),
                            Mean = mean(value, na.rm = TRUE),
                            SD = sd(value, na.rm = TRUE),
                            min = min(value, na.rm = TRUE),
                            max = max(value, na.rm = TRUE),
                            Skewness =
                              e1071::skewness(value, na.rm = TRUE, type = 2),
                            Kurtosis =
                              e1071::kurtosis(value, na.rm = TRUE, type = 2),
                            '% Missing' =
                              100 * (length(which(is.na(value))) / dplyr::n()))

  N <- dplyr::summarise(x, N.total = dplyr::n())
  N <- N$N.total[1]
  table <- dplyr::ungroup(table)
  table <- dplyr::arrange(table, match(Variable, col_order))

  table <- gt::gt(table) |>
    table_styling() |>
    gt::tab_header(title = "Descriptive Statistics") |>
    gt::fmt_number(decimals = digits) |>
    gt::tab_footnote(paste("Total N = ", N, sep = ""))
  return(table)
}