R/compute.group.dispersion.ADMn1.R

In burrm/lolcat: Miscellaneous Useful Functions

#' Calculate Subgroup Dispersion - Median (midpoint removed) Absolute Deviation
#' 
#' Calculate subgroup dispersion using absolute deviation from subgroup median (with midpoint removed).
#'
#' @param fx Formula - defines formula for dependent variable and subgroups ( dv ~ v1 + v2 + ...)
#' @param data Data Frame - data frame with columns corresponding to variables in fx. 
#'
#' @return A vector containing absolute deviations from subgroup medians (with midpoint removed).

compute.group.dispersion.ADMn1 <- function(
  fx           #Formula defining groups
  ,data = NULL #data frame
) {
  compute.group.variable(fx = fx,
                         data = data,
                         FUN = dispersion.ADMn1)
}