R/add_caption_css.R

In tableHTML: A Tool to Create HTML Tables

#' Add css to tableHTML's caption 
#'
#' \code{add_css_caption} will add css to a tableHTML's caption
#' 
#' \code{add_css_caption} will add css to a tableHTML's caption.
#'
#' @param tableHTML A tableHTML object created by the tableHTML function.
#'
#' @param css A list of two elements with the corresponding css. The first element of the list
#'   should be an atomic vector with the style definitions (e.g. background-color). The second
#'   element will be an atomic vector with the same length as the first element, which will 
#'   contain the style definitions' values (e.g. red). Check the examples for more information.
#'
#' @return A tableHTML object. 
#'         
#' @examples
#' tableHTML(mtcars, caption = 'This is a caption') %>% 
#'   add_css_caption(css = list(c('color', 'font-size'), c('blue', '50px'))) 
#' 
#' tableHTML(mtcars, caption = 'This is a caption') %>% 
#'   add_css_caption(css = list(c('color', 'font-size'), c('blue', '50px'))) %>%
#'   add_css_caption(css = list('background-color', 'green'))
#' 
#' @export
add_css_caption <- function(tableHTML, css) {
 
 #checks
 if (!inherits(tableHTML, 'tableHTML')) stop('tableHTML needs to be a tableHTML object')
 if (length(css[[1]]) != length(css[[2]])) stop('css needs to be a list of two elements of the
                                                same length') 
 
 attributes <- attributes(tableHTML)
 
 #create style
 css_comp <- paste0(css[[1]], ':', css[[2]], ';')
 css_comp <- paste(css_comp, collapse = '')
 
 style <- paste0('style="', css_comp, '"')
 
 tableHTML <- sub('<caption style=', '<caption', tableHTML)
 tableHTML <- sub('<caption', paste0('<caption ', style), tableHTML)
 tableHTML <- sub(';""', ';', tableHTML)
 
 attributes(tableHTML) <- attributes
 
 tableHTML
 
}