R/gt_probs.R

In FrankLef/fciR: Data and functions used with Fundamentals of Causal Inference by Babette Brumback

#' Create table of probabilities with \code{gt} package
#'
#' Create table of probabilities with \code{gt} package.
#'
#' Create table of probabilities with \code{gt} package. The last column
#' represents the probabilities.
#'
#' @param df Datafframe
#' @param digits Integer, number of digits to the right of decimal
#' @param title Title of the table
#' @param subtitle Subtitle of the table
#'
#' @importFrom dplyr %>%
#' @importFrom gt gt fmt_number
#'
#' @return A \code{gt_tbl} object
#' @export
gt_probs <- function(df, digits = 3, title, subtitle) {
  df %>%
    gt() %>%
    gt_basic(title, subtitle) %>%
    fmt_number(columns = "prob", decimals = digits)
}