R/ptd_calculate_assurance_type.R

In NHSRplotthedots: Draw XmR Charts for NHS 'Making Data Count' Programme

#' Calculate assurance type (internal function)
#'
#' Performs calculations to identify whether the SPC calculations indicate whether we will consistently pass the
#' target, consistently fail the target, or inconsistently pass/fail the target.
#'
#' @param .data A data frame containing the information to be plotted.
#' @return The calculated data frame
#'
#' @noRd
#'
ptd_calculate_assurance_type <- function(.data) {
  d <- .data %>%
    dplyr::group_by(.data$f) %>%
    dplyr::slice_tail(n = 1)

  options <- attr(.data, "options")

  if (is.null(options$target) || options$improvement_direction == "neutral") {
    return(dplyr::summarise(d, assurance_type = as.character(NA), .groups = "drop"))
  }

  # linting reports this is assigned by not used, so excluding line from linting as it is used
  is_increasing <- options$improvement_direction == "increase" # Exclude Linting

  d %>%
    dplyr::summarise(
      assurance_type = dplyr::case_when(
        target > upl ~ ifelse(is_increasing, "consistent_fail", "consistent_pass"),
        target < lpl ~ ifelse(is_increasing, "consistent_pass", "consistent_fail"),
        TRUE ~ "inconsistent"
      ),
      .groups = "drop"
    )
}