R/tabular.R

In acidgenomics/bb8: Acid Genomics Developer Tools

#' R documentation table
#'
#' @export
#' @note Updated 2019-08-13.
#'
#' @param x `data.frame`.
#'
#' @return Console output.
#'
#' @seealso
#' - http://r-pkgs.had.co.nz/man.html
#'
#' @examples
#' df <- data.frame(
#'     "aaa" = seq(from = 1L, to = 4L),
#'     "bbb" = seq(from = 2L, to = 5L),
#'     "ccc" = seq(from = 3L, to = 6L),
#'     row.names = c("AAA", "BBB", "CCC", "DDD")
#' )
#' tabular(df)
tabular <- function(x) {
    stopifnot(is.data.frame(x))
    align <- function(x) {
        ifelse(
            test = is.numeric(x),
            yes = "r",
            no = "l"
        )
    }
    align <- vapply(X = x, FUN = align, FUN.VALUE = character(1L))
    cols <- lapply(X = x, FUN = format)
    contents <- do.call(
        what = "paste",
        args = c(cols, list(sep = " \\tab ", collapse = "\\cr\n  "))
    )
    out <- paste0(
        "\\tabular{",
        paste(align, collapse = ""),
        "}{\n  ",
        contents,
        "\n}\n"
    )
    cat(out)
}