R/amo_target.R

In tnedu/acct: Frequently Used Accountability Functions

#' Calculate AMO Targets
#'
#' Family of functions for calcuating AMO targets. Includes functions for
#' AMO reduction targets and double AMO targets.
#'
#' @param n A count (valid tests, enrolled, etc.). Targets are only calculated if
#' count is 30 or greater.
#' @param pct A percentage (Percent On Track/Mastered, Chronic Absenteeism, etc.).
#' @param double Calculate double AMO target? Defaults to FALSE.
#' @param n_minimum Minimum N count to calculate AMO target. Defaults to 30.
#'
#' @export
#'
#' @examples
#'
#' amo_target(n = 30, pct = 36)
#'
#' # Equivalent
#' amo_reduction(n = 50, pct = 20.7, double = TRUE)
#' amo_reduction_double(n = 50, pct = 20.7)
#'
amo_target <- function(n, pct, double = FALSE, n_minimum = 30) {
    if (!double) {
        denom <- 16
    } else {
        denom <- 8
    }

    ifelse(n >= n_minimum, round5(pct + (100 - pct)/denom, 1), NA_real_)
}

#' @export
amo_reduction <- function(n, pct, double = FALSE, n_minimum = 30) {
    if (!double) {
        denom <- 16
    } else {
        denom <- 8
    }

    ifelse(n >= n_minimum, round5(pct - pct/denom, 1), NA_real_)
}

#' @export
amo_reduction_double <- function(n, pct, double = FALSE, n_minimum = 30) {
    if (!double) {
        denom <- 8
    } else {
        denom <- 4
    }

    ifelse(n >= n_minimum, round5(pct - pct/denom, 1), NA_real_)
}