R/balance_check.R

In DSCI-310/DSCI-310-Group-2-packages: What the Package Does (One Line, Title Case)

library(rlang)
library(tidyverse)
#' Creates a table
#'
#' take a data frame and an unquoted name of one column and creates a table with the percentage and count of the desired column's differnet values
#' Specified column must only have numeric types
#'
#' @param df A dataframe or dataframe extension
#' @param col_n An unquoted column name of the desired column
#'
#' @return A table with three columns
#' @export
#'
#' @examples
#' balance_check(heart_disease_clean, diagnosis)
balance_check <- function(df, col_n) {
  if (!is.data.frame(df)) {
    stop("`df` should be a dataframe")
  }
  else {
    num_obs <- nrow(df)
    output <- dplyr::group_by(df, {{col_n}}) %>%
      dplyr::summarise(count := dplyr::n(),
                       percentage := dplyr::n() / num_obs * 100)
    output
  }
}