R/df_counts.R

In mosaicModel: An Interface to Statistical Modeling Independent of Model Architecture

#' Formula interface to counts
#' 
#' Counts the number of cases in a data frame broken down by the 
#' variables in the formula. 
#' @param formula the formula describing the relationship
#' @param data a data frame (or you can pipe this in)
#' @param wide reformat the output as a cross-tabulation. This makes sense only when there are just two variables
#' @param margins show the marginal counts. Makes the most sense if \code{wide = TRUE}.
#' 
#' @seealso \code{df_props}
#' @export
df_counts <- function(formula, data, 
                      wide = FALSE, margins = FALSE) {
  df_props(formula = formula, data = data, wide = wide,
           margins = margins, format = "count")
}