R/kable_ueb.R

In uebvhir/anaStatsUEB: Statistical analysis function, Statistics and Bioinformatics Unit (UEB, VHIR)

#' A kable_ueb Function
#'
#' DESCRIPCIO DE LA FUNCIO
#' @param tab table to kable
#' @param caption Character vector containing the table's caption or title. Set to NULL to suppress the caption. Default value is NULL.
#' @param font_size A numeric input for table font size
#' @param full_width A TRUE or FALSE variable controlling whether the HTML table should have 100% width. Since HTML and pdf have different flavors on the preferable format for full_width. If not specified, a HTML table will have full width by default but this option will be set to FALSE for a LaTeX table
#' @param escape Boolean; whether to escape special characters when producing HTML or LaTeX tables. When escape = FALSE, you have to make sure that special characters will not trigger syntax errors in LaTeX or HTML.
#' @param col.background A character string for row background color. Here please pay attention to the differences in color codes between HTML and LaTeX.
#' @export kable_ueb
#' @keywords kable html ueb
#' @import kableExtra
#' @examples
#' aa <- data.frame(num = rnorm(10), fact= factor(rep(c("A","B","C"), 10)))
#' kable_ueb(aa)
#' kable_ueb(aa, digits = 2, row.names = TRUE, position = "left")
#' kable_ueb(aa, digits = 2, row.names = TRUE, format = "latex")



kable_ueb <- function(tab,
                      caption = NULL,
                      font_size = 13,
                      full_width = FALSE,
                      escape = FALSE,
                      col.background = "#993489",
                      position = "center",
                      ...){
  options(knitr.kable.NA = '')
  kable(tab, caption = caption, escape = escape, ...) %>%
    kable_styling(latex_options = c("striped","hold_position",
                                    "repeat_header"),
                  position = position,
                  font_size = font_size, full_width = full_width) %>%
    row_spec(0,background = col.background, color = "white")
}