R/stopFun_mantelhaenszel.R

In mirka-henninger/raschTreeEffectSize: Helper functions to use the Mantel-Haenszel effect size measure as a stopping criterion in Rasch trees

#' Returns a function that can be used for the stopfun argument in the Raschtree.
#' The stopping function returns a logical indicating whether all items are classified as the stopping criterion in the tree growing process
#' It uses the calculate_mantelhaenszel function for the Mantel-Haenszel effect size measure and classification
#' @param purification A character indicating the type of purification should be used? Options "none", "2step", "iterative"
#' @param stopcrit A character indicating when the Raschtree should be stopped. Default is "A", hence the Raschtree is stopped when all items fall into category "A" of the ETS classification scheme. When c("A", "B"), the Raschtree is stopped when all items fall in either category "A" or "B".
#'
#' @return A function that can be used for the stopfun argument in the Raschtree
#' @export
stopfun_mantelhaenszel <- function(purification, stopcrit = c("A")){
  stopfun <- function(y, kidids){
    dat <- y
    group <- kidids - 1
    sums <- rowSums(dat)
    MH <- calculate_mantelhaenszel(dat = dat, split_group = group, sums = sums, purification = purification)$classification
    return(all(MH %in% stopcrit))
  }
  return(stopfun)
}