R/evaluate.R

In yotamleibovici/twostageshrink: Perform and Compare Two-Stage Procedures and Shrinkage Estimators

#' Evaluate a testing procedure
#'
#' @param data A tibble, consists the \code{logical} columns \code{altr},
#'   indicating whether the hypothesis is a true alternative, and
#'   \code{final_result}, indicating whether the null hypothesis rejected
#'   (considered as an alternative).
#' @inheritParams perform
#'
#' @return A tibble consists two columns, \code{frej} and \code{trej}, which are
#'   the number of the false (true) rejections in each group.
#' @export
#'
#' @examples
evaluate <- function(data, ...) {
  group <- rlang::enexprs(...)

  assertthat::assert_that(
    is.data.frame(data),
    assertthat::has_name(data, group %>% purrr::map(as.character())),
    assertthat::has_name(data, c("altr", "final_result"))
  )

  data %>%
    dplyr::group_by(!!!group) %>%
    dplyr::summarise(
      frej = sum(!altr & final_result),
      trej = sum( altr & final_result)
    )
}