R/crosstable.R

In ssinari/smisc: Miscellaneous functions used by shripad sinari

#' A crosstable in LaTeX
#' @import magrittr
#' @import stats
#' @import utils
#' @param data a dataframe
#' @param caption caption for the table produced by the function.
#' @param digits number of digits in the output.
#' 
#' The following parameters will be passed to xtabs and addmargins from stats
#'     package. 
#' @param formula a formula involving columns names of data. This formula will
#'     produce the crosstable and will be passed to xtabs function from stats
#'     package.
#' @param addmargins parameter for addmargins from stats package.
#' @return a latex crosstable with caption and margins
#' @export
ss_xtabs <- function(formula, data, caption = "", addmargins = NULL, digits = 0){
  requireNamespace("magrittr", quietly = TRUE)
  requireNamespace("stats", quietly = TRUE)
  requireNamespace("utils", quietly = TRUE)
  cat("\\begin{table}[!h]\n")
  cat(paste0("\\caption{", caption,"}\n"))
  cat("\\begin{center}\n")
  xtbl <- xtabs(formula, data = data)
  if(!is.null(addmargins)) xtbl <- xtbl %>% addmargins(addmargins)
  xtbl %>%
    ftable() %>%
    utils::toLatex(digits = digits) %>% cat()
  cat("\\end{center}\n")
  cat("\\end{table}\n")
  
}

## quiets concerns of R CMD check re: the .'s that appear in pipelines
if(getRversion() >= "2.15.1")  utils::globalVariables(c("."))