column_spec: Specify the look of the selected column

In kableExtra: Construct Complex Table with 'kable' and Pipe Syntax

Specify the look of the selected column

Description

This function allows users to select a column and then specify its look.

Usage

column_spec(
  kable_input,
  column,
  width = NULL,
  bold = FALSE,
  italic = FALSE,
  monospace = FALSE,
  underline = FALSE,
  strikeout = FALSE,
  color = NULL,
  background = NULL,
  border_left = FALSE,
  border_right = FALSE,
  width_min = NULL,
  width_max = NULL,
  extra_css = NULL,
  include_thead = FALSE,
  latex_column_spec = NULL,
  latex_valign = "p",
  link = NULL,
  new_tab = TRUE,
  tooltip = NULL,
  popover = NULL,
  image = NULL
)

Arguments

kable_input	Output of knitr::kable() with format specified
column	A numeric value or vector indicating which column(s) to be selected.
width	A character string telling HTML & LaTeX how wide the column needs to be, e.g. "10cm", "3in" or "30em".
bold	T/F value or vector to control whether the text of the selected column need to be bolded.
italic	T/F value or vector to control whether the text of the selected column need to be emphasized.
monospace	T/F value or vector to control whether the text of the selected column need to be monospaced (verbatim)
underline	T/F value or vector to control whether the text of the selected row need to be underlined
strikeout	T/F value or vector to control whether the text of the selected row need to be struck out.
color	A character string or vector for column text color. Here please pay attention to the differences in color codes between HTML and LaTeX.
background	A character string or vector for column background color. Here please pay attention to the differences in color codes between HTML and LaTeX.
border_left	A logical variable indicating whether there should be a border line on the left of the selected column. In HTML, you can also pass in a character string for the CSS of the border line
border_right	A logical variable indicating whether there should be a border line on the right of the selected column. In HTML, you can also pass in a character string for the CSS of the border line
width_min	Only for HTML table. Normal column width will automatically collapse when the window cannot hold enough contents. With this width_min, you can set up a column with a width that won't collapse even when the window is not wide enough.
width_max	Only for HTML table. width_max defines the maximum width of table columns.
extra_css	A vector of extra css text to be passed into the cells of the column.
include_thead	T/F. A HTML only feature to control whether the header row will be manipulated. Default is FALSE.
latex_column_spec	Only for LaTeX tables. Code to replace the column specification. If not NULL, will override all other arguments.
latex_valign	vertical alignment. Only works when you specified column width. Choose among p, m, b.
link	A vector of strings for url links.
new_tab	T/F for whether to open up the new link in new tab
tooltip	A vector of strings to be displayed as tooltip. Obviously, this feature is only available in HTML. Read the package vignette to see how to use bootstrap tooltip css to improve the loading speed and look.
popover	Similar with tooltip but can hold more contents. The best way to build a popover is through spec_popover(). If you only provide a text string, it will be used as content. Note that You have to enable this bootstrap module manually. Read the package vignette to see how.
image	Vector of image paths.

Details

Use latex_column_spec in a LaTeX table to change or customize the column specification. Because of the way it is handled internally, any backslashes must be escaped.

Examples

## Not run: 
x <- knitr::kable(head(mtcars), "html")
column_spec(x, 1:2, width = "20em", bold = TRUE, italic = TRUE)
x <- knitr::kable(head(mtcars), "latex", booktabs = TRUE)
column_spec(x, 1, latex_column_spec = ">{\\\\color{red}}c")

## End(Not run)

kableExtra documentation built on June 22, 2024, 10:59 a.m.