Basic HTML table

Basic HTML output of kable looks very crude. To the end, it’s just a plain HTML table without any love from css.

kbl(dt)

Bootstrap theme

When used on a HTML table, kable_styling() will automatically apply twitter bootstrap theme to the table. Now it should looks the same as the original Pandoc output (the one when you don’t specify format in kable()) but this time, you are controlling it.

dt %>%
  kbl() %>%
  kable_styling()

Alternative themes

kableExtra also offers a few in-house alternative HTML table themes other than the default bootstrap theme. Right now there are 6 of them: kable_paper, kable_classic, kable_classic_2, kable_minimal, kable_material and kable_material_dark. These functions are alternatives to kable_styling, which means that you can specify any additional formatting options in kable_styling in these functions too. The only difference is that bootstrap_options (as discussed in the next section) is replaced with lightable_options at the same location with only two choices striped and hover available.

dt %>%
  kbl() %>%
  kable_paper("hover", full_width = F)

dt %>%
  kbl(caption = "Recreating booktabs style table") %>%
  kable_classic(full_width = F, html_font = "Cambria")

dt %>%
  kbl() %>%
  kable_classic_2(full_width = F)

dt %>%
  kbl() %>%
  kable_minimal()

dt %>%
  kbl() %>%
  kable_material(c("striped", "hover"))

dt %>%
  kbl() %>%
  kable_material_dark()

Bootstrap table classes

If you are familiar with twitter bootstrap, you probably have already known its predefined classes, including striped, bordered, hover, condensed and responsive. If you are not familiar, no worries, you can take a look at their documentation site to get a sense of how they look like. All of these options are available here.

For example, to add striped lines (alternative row colors) to your table and you want to highlight the hovered row, you can simply type:

kbl(dt) %>%
  kable_styling(bootstrap_options = c("striped", "hover"))

The option condensed can also be handy in many cases when you don’t want your table to be too large. It has slightly shorter row height.

kbl(dt) %>%
  kable_styling(bootstrap_options = c("striped", "hover", "condensed"))

Tables with option responsive looks the same with others on a large screen. However, on a small screen like phone, they are horizontally scrollable. Please resize your window to see the result.

kbl(dt) %>%
  kable_styling(bootstrap_options = c("striped", "hover", "condensed", "responsive"))

Full width?

By default, a bootstrap table takes 100% of the width. It is supposed to use together with its grid system to scale the table properly. However, when you are writing an R Markdown document, you probably don’t want to write your own css/or grid. For some small tables with only few columns, a page wide table looks awful. To make it easier, you can specify whether you want the table to have full_width or not in kable_styling. By default, full_width is set to be TRUE for HTML tables (note that for LaTeX, the default is FALSE since I don’t want to change the “common” looks unless you specified it.)

kbl(dt) %>%
  kable_paper(bootstrap_options = "striped", full_width = F)

Position

Table Position only matters when the table doesn’t have full_width. You can choose to align the table to center, left or right side of the page

kbl(dt) %>%
  kable_styling(bootstrap_options = "striped", full_width = F, position = "left")

Besides these three common options, you can also wrap text around the table using the float-left or float-right options.

kbl(dt) %>%
  kable_styling(bootstrap_options = "striped", full_width = F, position = "float_right")

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras sit amet mauris in ex ultricies elementum vel rutrum dolor. Phasellus tempor convallis dui, in hendrerit mauris placerat scelerisque. Maecenas a accumsan enim, a maximus velit. Pellentesque in risus eget est faucibus convallis nec at nulla. Phasellus nec lacinia justo. Morbi fermentum, orci id varius accumsan, nibh neque porttitor ipsum, consectetur luctus risus arcu ac ex. Aenean a luctus augue. Suspendisse et auctor nisl. Suspendisse cursus ultrices quam non vulputate. Phasellus et pharetra neque, vel feugiat erat. Sed feugiat elit at mauris commodo consequat. Sed congue lectus id mattis hendrerit. Mauris turpis nisl, congue eget velit sed, imperdiet convallis magna. Nam accumsan urna risus, non feugiat odio vehicula eget.

Font size

If one of your tables is huge and you want to use a smaller font size for that specific table, you can use the font_size option.

kbl(dt) %>%
  kable_styling(bootstrap_options = "striped", font_size = 7)

Fixed Table Header Row

If you happened to have a very long table, you may consider to use this fixed_header option to fix the header row on top as your readers scroll. By default, the background is set to white. If you need a different color, you can set fixed_header = list(enabled = T, background = "red").

kbl(mtcars[1:10, 1:5]) %>%
  kable_styling(fixed_thead = T)

Column spec

When you have a table with lots of explanatory texts, you may want to specified the column width for different column, since the auto adjust in HTML may not work in its best way while basic LaTeX table is really bad at handling text wrapping. Also, sometimes, you may want to highlight a column (e.g. a “Total” column) by making it bold. In these scenario, you can use column_spec(). You can find an example below.

Warning: If you have a super long table, you should be cautious when you use column_spec as the xml node modification takes time.

text_tbl <- data.frame(
  Items = c("Item 1", "Item 2", "Item 3"),
  Features = c(
    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vehicula tempor ex. Morbi malesuada sagittis turpis, at venenatis nisl luctus a. ",
    "In eu urna at magna luctus rhoncus quis in nisl. Fusce in velit varius, posuere risus et, cursus augue. Duis eleifend aliquam ante, a aliquet ex tincidunt in. ", 
    "Vivamus venenatis egestas eros ut tempus. Vivamus id est nisi. Aliquam molestie erat et sollicitudin venenatis. In ac lacus at velit scelerisque mattis. "
  )
)

kbl(text_tbl) %>%
  kable_paper(full_width = F) %>%
  column_spec(1, bold = T, border_right = T) %>%
  column_spec(2, width = "30em", background = "yellow")

Key Update: I understand the need of doing conditional formatting and the previous solution cell_spec is relatively hard to use. Therefore in kableExtra 1.2, I improved the functionality of column_spec so it can take vectorized input for most of its arguments (except width, border_left and border_right). It is really easy right now to format a column based on other values.

mtcars[1:8, 1:8] %>%
  kbl() %>%
  kable_paper(full_width = F) %>%
  column_spec(2, color = spec_color(mtcars$mpg[1:8]),
              link = "https://haozhu233.github.io/kableExtra/") %>%
  column_spec(6, color = "white",
              background = spec_color(mtcars$drat[1:8], end = 0.7),
              popover = paste("am:", mtcars$am[1:8]))

You can still use the spec_*** helper functions to help you define color. See the documentation below.

Insert Images into Columns

Technically, we are still talking about column_spec here. However, since this topic itself contains its own subtopics, we split it out as a separate section. Since kableExtra 1.2, we introduced the feature of adding images to columns of tables. Here is a quick example.

tbl_img <- data.frame(
  name = c("kableExtra 1", "kableExtra 2"),
  logo = ""
)
tbl_img %>%
  kbl(booktabs = T) %>%
  kable_paper(full_width = F) %>%
  column_spec(2, image = "kableExtra_sm.png")

name	logo
kableExtra 1
kableExtra 2

If you need to specify the size of the images, you need to do it through spec_image.

tbl_img %>%
  kbl(booktabs = T) %>%
  kable_paper(full_width = F) %>%
  column_spec(2, image = spec_image(
    c("kableExtra_sm.png", "kableExtra_sm.png"), 50, 50))

name	logo
kableExtra 1
kableExtra 2

kableExtra also provides a few inline plotting tools. Right now, there are spec_hist, spec_boxplot, and spec_plot. One key feature is that by default, the limits of every subplots are fixed so you can compare across rows. Note that in html, you can also use package sparkline to create some jQuery based interactive sparklines. Check out the end of this guide for details.

mpg_list <- split(mtcars$mpg, mtcars$cyl)
disp_list <- split(mtcars$disp, mtcars$cyl)
inline_plot <- data.frame(cyl = c(4, 6, 8), mpg_box = "", mpg_hist = "",
                          mpg_line1 = "", mpg_line2 = "",
                          mpg_points1 = "", mpg_points2 = "", mpg_poly = "")
inline_plot %>%
  kbl(booktabs = TRUE) %>%
  kable_paper(full_width = FALSE) %>%
  column_spec(2, image = spec_boxplot(mpg_list)) %>%
  column_spec(3, image = spec_hist(mpg_list)) %>%
  column_spec(4, image = spec_plot(mpg_list, same_lim = TRUE)) %>%
  column_spec(5, image = spec_plot(mpg_list, same_lim = FALSE)) %>%
  column_spec(6, image = spec_plot(mpg_list, type = "p")) %>%
  column_spec(7, image = spec_plot(mpg_list, disp_list, type = "p")) %>%
  column_spec(8, image = spec_plot(mpg_list, polymin = 5))

There is also a spec_pointrange function specifically designed for forest plots in regression tables. Of course, feel free to use it for other purposes.

coef_table <- data.frame(
  Variables = c("var 1", "var 2", "var 3"),
  Coefficients = c(1.6, 0.2, -2.0),
  Conf.Lower = c(1.3, -0.4, -2.5),
  Conf.Higher = c(1.9, 0.6, -1.4)
) 

data.frame(
  Variable = coef_table$Variables,
  Visualization = ""
) %>%
  kbl(booktabs = T) %>%
  kable_classic(full_width = FALSE) %>%
  column_spec(2, image = spec_pointrange(
    x = coef_table$Coefficients, 
    xmin = coef_table$Conf.Lower, 
    xmax = coef_table$Conf.Higher, 
    vline = 0)
    )

Row spec

Similar with column_spec, you can define specifications for rows. Currently, you can either bold or italicize an entire row. Note that, similar with other row-related functions in kableExtra, for the position of the target row, you don’t need to count in header rows or the group labeling rows.

kbl(dt) %>%
  kable_paper("striped", full_width = F) %>%
  column_spec(5:7, bold = T) %>%
  row_spec(3:5, bold = T, color = "white", background = "#D7261E")

Header Rows

One special case of row_spec is that you can specify the format of the header row via row_spec(row = 0, ...).

kbl(dt) %>%
  kable_paper("striped", full_width = F) %>%
  row_spec(0, angle = -45)

Conditional logic

Key Update: Again, as said before, if you are using kableExtra 1.2+, you are now recommended to used column_spec to do conditional formatting.

It is very easy to use cell_spec with conditional logic. Here is an example.

cs_dt <- mtcars[1:10, 1:2]
cs_dt$car = row.names(cs_dt)
row.names(cs_dt) <- NULL
cs_dt$mpg = cell_spec(cs_dt$mpg, color = ifelse(cs_dt$mpg > 20, "red", "blue"))
cs_dt$cyl = cell_spec(
  cs_dt$cyl, color = "white", align = "c", angle = 45, 
  background = factor(cs_dt$cyl, c(4, 6, 8), c("#666666", "#999999", "#BBBBBB")))
cs_dt <- cs_dt[c("car", "mpg", "cyl")]

kbl(cs_dt, escape = F) %>%
  kable_paper("striped", full_width = F)

# You can also do this with dplyr and use one pipe from top to bottom
# library(dplyr)
# mtcars[1:10, 1:2] %>%
#   mutate(
#     car = row.names(.),
#     mpg = cell_spec(mpg, "html", color = ifelse(mpg > 20, "red", "blue")),
#     cyl = cell_spec(cyl, "html", color = "white", align = "c", angle = 45, 
#                     background = factor(cyl, c(4, 6, 8), 
#                                         c("#666666", "#999999", "#BBBBBB")))
#   ) %>%
#   select(car, mpg, cyl) %>%
#   kbl(format = "html", escape = F) %>%
#   kable_paper("striped", full_width = F)

Visualize data with Viridis Color

This package also comes with a few helper functions, including spec_color, spec_font_size & spec_angle. These functions can rescale continuous variables to certain scales. For example, function spec_color would map a continuous variable to any color palettes, by default viridis palettes. It offers a very visually impressive representation in a tabular format.

vs_dt <- iris[1:10, ]
vs_dt[1:4] <- lapply(vs_dt[1:4], function(x) {
    cell_spec(x, bold = T, 
              color = spec_color(x, end = 0.9),
              font_size = spec_font_size(x))
})
vs_dt[5] <- cell_spec(vs_dt[[5]], color = "white", bold = T,
    background = spec_color(1:10, end = 0.9, option = "A", direction = -1))
kbl(vs_dt, escape = F, align = "c") %>%
  kable_classic("striped", full_width = F)

# Or dplyr ver
# iris[1:10, ] %>%
#   mutate_if(is.numeric, function(x) {
#     cell_spec(x, bold = T, 
#               color = spec_color(x, end = 0.9),
#               font_size = spec_font_size(x))
#   }) %>%
#   mutate(Species = cell_spec(
#     Species, color = "white", bold = T,
#     background = spec_color(1:10, end = 0.9, option = "A", direction = -1)
#   )) %>%
#   kable(escape = F, align = "c") %>%
#   kable_paper(c("striped", "condensed"), full_width = F)

Text Specification

If you check the results of cell_spec, you will find that this function does nothing more than wrapping the text with appropriate HTML/LaTeX formatting syntax. The result of this function is just a vector of character strings. As a result, when you are writing an R Markdown document or write some text in shiny apps, if you need extra markups other than bold or italic, you may use this function to color, change font size or rotate your text.

An aliased function text_spec is also provided for a more literal writing experience. In HTML, there is no difference between these two functions.

sometext <- strsplit(paste0(
  "You can even try to make some crazy things like this paragraph. ", 
  "It may seem like a useless feature right now but it's so cool ",
  "and nobody can resist. ;)"
), " ")[[1]]
text_formatted <- paste(
  text_spec(sometext, color = spec_color(1:length(sometext), end = 0.9),
            font_size = spec_font_size(1:length(sometext), begin = 5, end = 20)),
  collapse = " ")

# To display the text, type `r text_formatted` outside of the chunk

You can even try to make some crazy things like this paragraph. It may seem like a useless feature right now but it’s so cool and nobody can resist. ;)

Tooltip

It’s very easy to add a tooltip to text via cell_spec. For example, text_spec("tooltip", color = "red", tooltip = "Hello World") will give you something like Hover over me (you need to wait for a few seconds before your browser renders it).

Note that the original browser-based tooltip is slow. If you want to have a faster response, you may want to initialize bootstrap’s tooltip by putting the following HTML code on the page.

<script>
$(document).ready(function(){
    $('[data-toggle="tooltip"]').tooltip(); 
});
</script>

In an R Markdown document, you can just drop it outside of any R chunks. Unfortunately however, for R Markdown pages with a floating TOC (like this page), you can’t use bootstrap tooltips because there is a conflict in namespace between Bootstrap and jQuery UI (tocify.js). As a result, I can’t provide a live demo here. If you want to have a tooltip together with a floating TOC, you should use popover which has a very similar effect.

Popover Message

The popover message looks very similar with tooltip but it can hold more contents. Unlike tooltip which can minimally work without you manually enable that module, you have to enable the popover module to get it work. The upper side is that there is no conflict between Bootstrap & jQuery UI this time, you can use it without any concern.

<script>
$(document).ready(function(){
    $('[data-toggle="popover"]').popover(); 
});
</script>

popover_dt <- data.frame(
  position = c("top", "bottom", "right", "left"),
  stringsAsFactors = FALSE
)
popover_dt$`Hover over these items` <- cell_spec(
  paste("Message on", popover_dt$position), # Cell texts
  popover = spec_popover(
    content = popover_dt$position,
    title = NULL,                           # title will add a Title Panel on top
    position = popover_dt$position
  ))
kbl(popover_dt, escape = FALSE) %>%
  kable_paper("striped", full_width = FALSE)

Links

You can add links to text via text_spec("kableExtra", link = "https://haozhu233.github.io/kableExtra/"): kableExtra. If you want your hover message to be more obvious, it might be a good idea to put a # (go back to the top of the page) or javascript:void(0) (literally do nothing) in the link option. text_spec("Hover on me", link = "javascript:void(0)", popover = "Hello"): Hover on me

Integration with formattable

You can combine the good parts from kableExtra & formattable together into one piece. Read more at http://haozhu233.github.io/kableExtra/use_kableExtra_with_formattable.html

library(formattable)
ft_dt <- mtcars[1:5, 1:4]
ft_dt$car <- row.names(ft_dt)
row.names(ft_dt) <- NULL
ft_dt$mpg <- color_tile("white", "orange")(ft_dt$mpg)
ft_dt$cyl <- cell_spec(ft_dt$cyl, angle = (1:5)*60, 
                      background = "red", color = "white", align = "center")
ft_dt$disp <- ifelse(
  ft_dt$disp > 200,
  cell_spec(ft_dt$disp, color = "red", bold = T),
  cell_spec(ft_dt$disp, color = "green", italic = T)
)
ft_dt$hp <- color_bar("lightgreen")(ft_dt$hp)
ft_dt <- ft_dt[c("car", "mpg", "cyl", "disp", "hp")]

kbl(ft_dt, escape = F) %>%
  kable_paper("hover", full_width = F) %>%
  column_spec(5, width = "3cm") %>%
  add_header_above(c(" ", "Hello" = 2, "World" = 2))

Add header rows to group columns

Tables with multi-row headers can be very useful to demonstrate grouped data. To do that, you can pipe your kable object into add_header_above(). The header variable is supposed to be a named character with the names as new column names and values as column span. For your convenience, if column span equals to 1, you can ignore the =1 part so the function below can be written as `add_header_above(c(” “,”Group 1” = 2, “Group 2” = 2, “Group 3” = 2)).

kbl(dt) %>%
  kable_classic() %>%
  add_header_above(c(" " = 1, "Group 1" = 2, "Group 2" = 2, "Group 3" = 2))

In fact, if you want to add another row of header on top, please feel free to do so.

kbl(dt) %>%
  kable_paper() %>%
  add_header_above(c(" ", "Group 1" = 2, "Group 2" = 2, "Group 3" = 2)) %>%
  add_header_above(c(" ", "Group 4" = 4, "Group 5" = 2)) %>%
  add_header_above(c(" ", "Group 6" = 6))

Group rows via labeling

Sometimes we want a few rows of the table being grouped together. They might be items under the same topic (e.g., animals in one species) or just different data groups for a categorical variable (e.g., age < 40, age > 40). With the function group_rows()/pack_rows() in kableExtra, this kind of task can be completed in one line. Please see the example below. Note that when you count for the start/end rows of the group, you don’t need to count for the header rows nor other group label rows. You only need to think about the row numbers in the “original R dataframe”.

kbl(mtcars[1:10, 1:6], caption = "Group Rows") %>%
  kable_paper("striped", full_width = F) %>%
  pack_rows("Group 1", 4, 7) %>%
  pack_rows("Group 2", 8, 10)

Another way to use pack_rows is to provide an grouping index, similar with add_header_above(). This feature is only available in kableExtra > 0.5.2.

# Not evaluated. This example generates the same table as above.
kbl(mtcars[1:10, 1:6], caption = "Group Rows") %>%
  kable_paper("striped", full_width = F) %>%
  pack_rows(index = c(" " = 3, "Group 1" = 4, "Group 2" = 3))

For advanced users, you can even define your own css for the group labeling.

kbl(dt) %>%
  kable_paper("striped", full_width = F) %>%
  pack_rows("Group 1", 3, 5, label_row_css = "background-color: #666; color: #fff;")

Important Note!

Note that dplyr 0.8.0+ introduced a group_rows function as well for a trivial feature. Therefore, I’m create this pack_rows function as an alias to the original group_rows. In the future, I recommend all kableExtra users to use pack_rows instead of group_rows to get rid of the NAMESPACE conflict.

Alternatively, for pre-existing codes, you have two ways to solve this. You can either load kableExtra after dplyr or tidyverse, or to use the conflicted package. Here is an example.

# Method 1
pack_rows() # instead of group_rows()

# Method 2
library(dplyr)
library(kableExtra)

# Method 3
conflicted::conflict_prefer("group_rows", "kableExtra", "dplyr")

Row indentation

Unlike pack_rows(), which will insert a labeling row, sometimes we want to list a few sub groups under a total one. In that case, add_indent() is probably more appropriate. For advanced users, you can even define your own css for the group labeling.

kbl(dt) %>%
  kable_paper("striped", full_width = F) %>%
  add_indent(c(1, 3, 5))

Group rows via multi-row cell

Function pack_rows is great for showing simple structural information on rows but sometimes people may need to show structural information with multiple layers. When it happens, you may consider to use collapse_rows instead, which will put repeating cells in columns into multi-row cells. The vertical alignment of the cell is controlled by valign with default as “top”.

collapse_rows_dt <- data.frame(C1 = c(rep("a", 10), rep("b", 5)),
                 C2 = c(rep("c", 7), rep("d", 3), rep("c", 2), rep("d", 3)),
                 C3 = 1:15,
                 C4 = sample(c(0,1), 15, replace = TRUE))
kbl(collapse_rows_dt, align = "c") %>%
  kable_paper(full_width = F) %>%
  column_spec(1, bold = T) %>%
  collapse_rows(columns = 1:2, valign = "top")

Scroll box

If you have a huge table and you don’t want to reduce the font size to unreadable, you may want to put your HTML table in a scroll box, of which users can pick the part they like to read. Note that scroll box isn’t printer friendly, so be aware of that when you use this feature.

When you use scroll_box, you can specify either height or width. When you specify height, you will get a vertically scrollable box and vice versa. If you specify both, you will get a two-way scrollable box.

kbl(cbind(mtcars, mtcars)) %>%
  kable_paper() %>%
  scroll_box(width = "500px", height = "200px")

You can also specify width using a percentage.

kbl(cbind(mtcars, mtcars)) %>%
  add_header_above(c("a" = 5, "b" = 18)) %>%
  kable_paper() %>%
  scroll_box(width = "100%", height = "200px")

Starting from version 1.1.0, if you have a fixed-height box, the header row is fixed

Save HTML table directly

If you need to save those HTML tables but you don’t want to generate them through R Markdown, you can try to use the save_kable() function. You can choose whether to let those HTML files be self contained (default is yes). Self contained files packed CSS into the HTML file so they are quite large when there are many.

kbl(mtcars) %>%
  kable_paper() %>%
  save_kable(file = "table1.html", self_contained = T)

Use it with sparkline

Well, this is not a feature but rather a documentation of how to use the sparkline package together with this package. The easiest way is sort of a hack. You can call sparkline::sparkline(0) somewhere on your document where no one would mind so its dependencies could be loaded without any hurdles. Then you use sparkline::spk_chr() to generate the text. For a working example, see: Chinese names in US babynames

# Not evaluated
library(sparkline)
sparkline::sparkline(0)

spk_dt <- data.frame(
  var = c("mpg", "wt"),
  sparkline = c(sparkline::spk_chr(mtcars$mpg), sparkline::spk_chr(mtcars$wt))
)

kbl(spk_dt, escape = F) %>%
  kable_paper(full_width = F)

tables

The latest version of tables comes with a toKable() function, which is compatible with functions in kableExtra (>=0.9.0).

xtable

For xtable users, if you want to use kableExtra functions on that, check out this xtable2kable() function shipped with kableExtra 1.0.

# Not evaluating
xtable::xtable(mtcars[1:4, 1:4], caption = "Hello xtable") %>%
  xtable2kable() %>%
  column_spec(1, color = "red")