R/compare_benchmark_score.R

In experiences: Experience Research

#' Compare Score with a Benchmark
#'
#' @param data a column or vector of scores
#' @param benchmark benchmark
#' @param alpha alpha
#' @param tail one-tailed or two-tailed test
#' @param remove_missing TRUE/FALSE remove missing values? (default is TRUE)
#' @return lower_ci, upper_ci, t, probability
#' @export
#' @importFrom stats pt sd na.omit
#' @importFrom huxtable as_hux position map_align by_cols print_screen
#' @examples
#' data <- 68 + 17 * scale(rnorm(20)) # 68 = mean, 17 = sd
#' compare_benchmark_score(data, benchmark = 60, alpha = 0.5)


compare_benchmark_score <- function(data, benchmark, alpha, tail = "one", remove_missing = TRUE) {

  mean <- mean(data, na.rm = remove_missing)
  sd <- sd(data, na.rm = remove_missing)

  if (remove_missing == TRUE) {
    n <- length(na.omit(data))
  } else {
    n <- length(data)
  }

  df <- n - 1

  t <- (mean - benchmark) / (sd / sqrt(n))

  if (tail == "one") {
    probability <- t_dist_one_tailed(t, df)
  } else if (tail == "two") {
    probability <- t_dist_two_tailed(t, df)
  } else {
    stop("arguments for tail must be 'one' or 'two'")
  }

  confidence <- 1 - probability

  se <- sd/sqrt(n)
  margin_of_error <- t*se

  lower_ci <- mean - margin_of_error
  upper_ci <- mean + margin_of_error

  list(mean = mean,
       sd = sd,
       se = se,
       n = n,
       df = df,
       alpha = alpha,
       probability = probability,
       tail = tail,
       confidence = confidence,
       margin_of_error = margin_of_error,
       t = t,
       lower_ci = lower_ci,
       upper_ci = upper_ci,
       text_output = paste("We can be",
                           paste0(round(confidence, 2)*100, "%"),
                           "confident that the true score is between",
                           round(lower_ci, 2), "and",
                           round(upper_ci, 2)))
}