blob: 4658a3cab3ea2a5e09d1b0840fc70bbdd3c22b0f [file] [log] [blame]
Hao Zhu1fc48a62017-03-01 14:07:54 -05001---
2title: "Create Awesome HTML Table with knitr::kable and kableExtra"
3author: "Hao Zhu"
4date: "`r Sys.Date()`"
5output:
6 html_document:
Hao Zhuaf646602017-03-01 19:22:18 -05007 theme: simplex
Hao Zhu1fc48a62017-03-01 14:07:54 -05008 toc: true
9 toc_depth: 2
10 toc_float: true
11vignette: >
12 %\VignetteIndexEntry{Create Awesome HTML Table with knitr::kable and kableExtra}
13 %\VignetteEngine{knitr::rmarkdown}
14 %\VignetteEncoding{UTF-8}
15---
16
Hao Zhudda2f722018-05-21 00:38:11 -040017<img src="kableExtra_sm.png" align="right" alt="logo" width="80" height = "93" style = "border: none; float: right;">
18
Hao Zhu0a0e8332017-08-03 13:21:29 -040019> Please see the package [documentation site](http://haozhu233.github.io/kableExtra/) for how to use this package in LaTeX.
Hao Zhu6ce29212017-05-22 16:29:56 -040020
Hao Zhu1fc48a62017-03-01 14:07:54 -050021# Overview
22The goal of `kableExtra` is to help you build common complex tables and manipulate table styles. It imports the pipe `%>%` symbol from `magrittr` and verbalize all the functions, so basically you can add "layers" to a kable output in a way that is similar with `ggplot2` and `plotly`.
23
Hao Zhu4b0c51e2017-08-01 15:21:07 -040024To learn how to generate complex tables in LaTeX, please visit [http://haozhu233.github.io/kableExtra/awesome_table_in_pdf.pdf](http://haozhu233.github.io/kableExtra/awesome_table_in_pdf.pdf)
25
Hao Zhu6107f372018-05-21 00:23:26 -040026There is also a Chinese version of this vignette. You can find it [here](http://haozhu233.github.io/kableExtra/awesome_table_in_html_cn.html)
27
Hao Zhu1fc48a62017-03-01 14:07:54 -050028# Installation
Hao Zhu1fc48a62017-03-01 14:07:54 -050029```r
Hao Zhu74eb6ad2017-03-04 09:32:37 -050030install.packages("kableExtra")
31
Hao Zhu1fc48a62017-03-01 14:07:54 -050032# For dev version
Hao Zhuf9aa4c42017-05-22 15:53:35 -040033# install.packages("devtools")
Hao Zhu1fc48a62017-03-01 14:07:54 -050034devtools::install_github("haozhu233/kableExtra")
35```
36# Getting Started
37Here we are using the first few columns and rows from dataset `mtcars`
38```{r}
39library(knitr)
40library(kableExtra)
41dt <- mtcars[1:5, 1:6]
42```
43
Hao Zhu6107f372018-05-21 00:23:26 -040044When you are using `kable()`, if you don't specify `format`, by default it will generate a markdown table and let pandoc handle the conversion from markdown to HTML/PDF. This is the most favorable approach to render most simple tables as it is format independent. If you switch from HTML to pdf, you basically don't need to change anything in your code. However, markdown doesn't support complex table. For example, if you want to have a double-row header table, markdown just cannot provide you the functionality you need. As a result, when you have such a need, you should **define `format` in `kable()`** as either "html" or "latex". *You can also define a global option at the beginning using `options(knitr.table.format = "html")` so you don't repeat the step everytime.*
45
46**Starting from `kableExtra` 0.9.0**, when you load this package (`library(kableExtra)`), `r text_spec("it will automatically set up the global option 'knitr.table.format' based on your current environment", bold = T, color = "white", background = "#d9230f")`. Unless you are rendering a PDF, `kableExtra` will try to render a HTML table for you. **You no longer need to manually set either the global option or the `format` option in each `kable()` function**. I'm still including the explanation above here in this vignette so you can understand what is going on behind the scene. Note that this is only an global option. You can manually set any format in `kable()` whenever you want. I just hope you can enjoy a peace of mind in most of your time.
47
48You can disable this behavior by setting `options(kableExtra.auto_format = FALSE)` before you load `kableExtra`.
Hao Zhu1fc48a62017-03-01 14:07:54 -050049
50```{r}
Hao Zhu6107f372018-05-21 00:23:26 -040051# If you are using kableExtra < 0.9.0, you are recommended to set a global option first.
52# options(knitr.table.format = "html")
Hao Zhu1fc48a62017-03-01 14:07:54 -050053## If you don't define format here, you'll need put `format = "html"` in every kable function.
54```
55
Hao Zhu4b0c51e2017-08-01 15:21:07 -040056## Basic HTML table
Hao Zhu1fc48a62017-03-01 14:07:54 -050057Basic HTML output of `kable` looks very crude. To the end, it's just a plain HTML table without any love from css.
58```{r}
Hao Zhu6107f372018-05-21 00:23:26 -040059kable(dt)
Hao Zhu1fc48a62017-03-01 14:07:54 -050060```
61
Hao Zhu4b0c51e2017-08-01 15:21:07 -040062## Bootstrap theme
Hao Zhu1fc48a62017-03-01 14:07:54 -050063When 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.
64```{r}
Hao Zhuf03decd2017-09-13 10:45:44 -040065dt %>%
Hao Zhu6107f372018-05-21 00:23:26 -040066 kable() %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -050067 kable_styling()
68```
69
Hao Zhud7762a42020-08-10 09:05:47 -040070## Alternative themes
Hao Zhud8a2e332020-08-11 01:26:32 -040071`kableExtra` also offers a few in-house alternative HTML table themes other than the default bootstrap theme. Right now there are 5 of them: `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.
Hao Zhud7762a42020-08-10 09:05:47 -040072
73```{r}
74dt %>%
75 kable() %>%
76 kable_classic()
77```
78
79```{r}
80dt %>%
81 kable() %>%
Hao Zhud8a2e332020-08-11 01:26:32 -040082 kable_classic_2()
83```
84
85```{r}
86dt %>%
87 kable() %>%
Hao Zhud7762a42020-08-10 09:05:47 -040088 kable_minimal()
89```
90
91```{r}
92dt %>%
93 kable() %>%
94 kable_material(c("striped", "hover"))
95```
96
Hao Zhu9bf19982020-08-11 00:50:33 -040097```{r}
98dt %>%
99 kable() %>%
100 kable_material_dark()
101```
102
Hao Zhud7762a42020-08-10 09:05:47 -0400103
104
Hao Zhu1fc48a62017-03-01 14:07:54 -0500105# Table Styles
Hao Zhu462b4492017-08-03 11:31:42 -0400106`kable_styling` offers a few other ways to customize the look of a HTML table.
Hao Zhu1fc48a62017-03-01 14:07:54 -0500107
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400108## Bootstrap table classes
Hao Zhue2706b32017-03-07 02:36:17 -0500109If 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](http://getbootstrap.com/css/#tables) to get a sense of how they look like. All of these options are available here.
Hao Zhu1fc48a62017-03-01 14:07:54 -0500110
111For example, to add striped lines (alternative row colors) to your table and you want to highlight the hovered row, you can simply type:
112```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400113kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500114 kable_styling(bootstrap_options = c("striped", "hover"))
115```
116
117The 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.
118```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400119kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500120 kable_styling(bootstrap_options = c("striped", "hover", "condensed"))
121```
122
123Tables 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.
124```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400125kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500126 kable_styling(bootstrap_options = c("striped", "hover", "condensed", "responsive"))
127```
128
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400129## Full width?
Hao Zhubf4cdc62017-03-02 22:26:29 -0500130By 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 a rmarkdown 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.)
Hao Zhu1fc48a62017-03-01 14:07:54 -0500131```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400132kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500133 kable_styling(bootstrap_options = "striped", full_width = F)
134```
135
136## Position
137Table 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
138```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400139kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500140 kable_styling(bootstrap_options = "striped", full_width = F, position = "left")
141```
142
143Becides these three common options, you can also wrap text around the table using the `float-left` or `float-right` options.
144```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400145kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500146 kable_styling(bootstrap_options = "striped", full_width = F, position = "float_right")
147```
148Lorem 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.
149
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400150## Font size
Hao Zhu1fc48a62017-03-01 14:07:54 -0500151If 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.
152```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400153kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500154 kable_styling(bootstrap_options = "striped", font_size = 7)
155```
156
Hao Zhu72917f92019-03-15 18:41:42 -0400157## Fixed Table Header Row
158If 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")`.
159
160```{r}
161kable(mtcars[1:10, 1:5]) %>%
162 kable_styling(fixed_thead = T)
163```
164
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400165# Column / Row Specification
166## Column spec
Hao Zhu4840bc92017-09-15 15:55:05 -0400167When 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.
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400168
169Warning: If you have a super long table, you should be cautious when you use `column_spec` as the xml node modification takes time.
170
171```{r}
172text_tbl <- data.frame(
173 Items = c("Item 1", "Item 2", "Item 3"),
174 Features = c(
175 "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vehicula tempor ex. Morbi malesuada sagittis turpis, at venenatis nisl luctus a. ",
176 "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. ",
177 "Vivamus venenatis egestas eros ut tempus. Vivamus id est nisi. Aliquam molestie erat et sollicitudin venenatis. In ac lacus at velit scelerisque mattis. "
178 )
179)
180
Hao Zhu6107f372018-05-21 00:23:26 -0400181kable(text_tbl) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400182 kable_styling(full_width = F) %>%
Hao Zhua44e3752017-09-05 12:56:19 -0400183 column_spec(1, bold = T, border_right = T) %>%
184 column_spec(2, width = "30em", background = "yellow")
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400185```
186
187
Hao Zhu0a0e8332017-08-03 13:21:29 -0400188## Row spec
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400189Similar with `column_spec`, you can define specifications for rows. Currently, you can either bold or italiciz 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 labelling rows.
190
191```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400192kable(dt) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400193 kable_styling("striped", full_width = F) %>%
Hao Zhu4840bc92017-09-15 15:55:05 -0400194 column_spec(5:7, bold = T) %>%
195 row_spec(3:5, bold = T, color = "white", background = "#D7261E")
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400196```
197
Hao Zhu9ce317e2017-10-12 18:19:55 -0400198
Hao Zhu6f362bb2017-10-23 23:21:38 -0400199
200## Header Rows
201One special case of `row_spec` is that you can specify the format of the header row via `row_spec(row = 0, ...)`.
202```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400203kable(dt) %>%
Hao Zhu6f362bb2017-10-23 23:21:38 -0400204 kable_styling("striped", full_width = F) %>%
205 row_spec(0, angle = -45)
Hao Zhu9ce317e2017-10-12 18:19:55 -0400206```
207
Hao Zhu6f362bb2017-10-23 23:21:38 -0400208# Cell/Text Specification
209Function `cell_spec` is introduced in version 0.6.0 of `kableExtra`. Unlike `column_spec` and `row_spec`, **this function is designed to be used before the data.frame gets into the `kable` function**. Comparing with figuring out a list of 2 dimentional index for targeted cells, this design is way easier to learn and use and it fits perfectly well with `dplyr`'s `mutate` and `summarize` functions. With this design, there are two things to be noted:
210* Since `cell_spec` generates raw `HTML` or `LaTeX` code, make sure you remember to put `escape = FALSE` in `kable`. At the same time, you have to escape special symbols including `%` manually by yourself
211* `cell_spec` needs a way to know whether you want `html` or `latex`. You can specify it locally in function or globally via the `options(knitr.table.format = "latex")` method as suggested at the beginning. If you don't provide anything, this function will output as HTML by default.
212
213Currently, `cell_spec` supports features including bold, italic, monospace, text color, background color, align, font size & rotation angle. More features may be added in the future. Please see function documentations as reference.
214
215## Conditional logic
216It is very easy to use `cell_spec` with conditional logic. Here is an example.
217```{r, message=FALSE, warning=FALSE}
218library(dplyr)
219mtcars[1:10, 1:2] %>%
220 mutate(
221 car = row.names(.),
Hao Zhu76762d82018-07-25 20:56:52 -0400222 mpg = cell_spec(mpg, "html", color = ifelse(mpg > 20, "red", "blue")),
223 cyl = cell_spec(cyl, "html", color = "white", align = "c", angle = 45,
Hao Zhu6f362bb2017-10-23 23:21:38 -0400224 background = factor(cyl, c(4, 6, 8),
225 c("#666666", "#999999", "#BBBBBB")))
226 ) %>%
227 select(car, mpg, cyl) %>%
Hao Zhu76762d82018-07-25 20:56:52 -0400228 kable(format = "html", escape = F) %>%
Hao Zhu6f362bb2017-10-23 23:21:38 -0400229 kable_styling("striped", full_width = F)
230```
231
232## Visualize data with Viridis Color
Hao Zhu07305132017-10-24 15:41:49 -0400233This 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 [viridis color palettes](https://CRAN.R-project.org/package=viridisLite). It offers a very visually impactful representation in a tabular format.
Hao Zhu6f362bb2017-10-23 23:21:38 -0400234
235```{r}
236iris[1:10, ] %>%
237 mutate_if(is.numeric, function(x) {
Hao Zhu6107f372018-05-21 00:23:26 -0400238 cell_spec(x, bold = T,
Hao Zhu5ece06e2018-01-19 23:18:02 -0500239 color = spec_color(x, end = 0.9),
Hao Zhu6f362bb2017-10-23 23:21:38 -0400240 font_size = spec_font_size(x))
241 }) %>%
242 mutate(Species = cell_spec(
Hao Zhu6107f372018-05-21 00:23:26 -0400243 Species, color = "white", bold = T,
Hao Zhu6f362bb2017-10-23 23:21:38 -0400244 background = spec_color(1:10, end = 0.9, option = "A", direction = -1)
245 )) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400246 kable(escape = F, align = "c") %>%
Hao Zhu222cd7e2018-04-10 14:27:19 -0400247 kable_styling(c("striped", "condensed"), full_width = F)
Hao Zhu6f362bb2017-10-23 23:21:38 -0400248```
249
250In the example above, I'm using the `mutate` functions from `dplyr`. You don't have to use it. Base R solutions like `iris$Species <- cell_spec(iris$Species, color = "red")` also works.
251
252## Text Specification
253If 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 a `rmarkdown` document or write some text in shiny apps, if you need extra markups other than **bold** or *italic*, you may use this function to `r text_spec("color", color = "red")`, `r text_spec("change font size ", font_size = 16)` or `r text_spec("rotate", angle = 30)` your text.
254
255An aliased function `text_spec` is also provided for a more literal writing experience. In HTML, there is no difference between these two functions.
256
257```{r}
258sometext <- strsplit(paste0(
Hao Zhu6290fdd2017-10-24 00:10:32 -0400259 "You can even try to make some crazy things like this paragraph. ",
Hao Zhu6a1cbb52017-10-24 15:54:50 -0400260 "It may seem like a useless feature right now but it's so cool ",
261 "and nobody can resist. ;)"
Hao Zhu6f362bb2017-10-23 23:21:38 -0400262), " ")[[1]]
263text_formatted <- paste(
Hao Zhu6107f372018-05-21 00:23:26 -0400264 text_spec(sometext, color = spec_color(1:length(sometext), end = 0.9),
Hao Zhu6f362bb2017-10-23 23:21:38 -0400265 font_size = spec_font_size(1:length(sometext), begin = 5, end = 20)),
266 collapse = " ")
267
268# To display the text, type `r text_formatted` outside of the chunk
269```
270`r text_formatted`
271
272## Tooltip
273It'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 `r text_spec("Hover over me", color = "red", tooltip = "Hello World")` (you need to wait for a few seconds before your browser renders it).
274
275Note 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.
276```
277<script>
278$(document).ready(function(){
279 $('[data-toggle="tooltip"]').tooltip();
280});
281</script>
282```
283
284In a rmarkdown document, you can just drop it outside of any R chunks. Unfortunately however, for rmarkdown pages with a **floating TOC** (like this page), you can't use bootstrap tooltips because there is a conflict in namespace between Bootstrap and JQueryUI (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.
285
286
287
288## Popover Message
289The 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 & JQueryUI this time, you can use it without any concern.
290
291```
292<script>
293$(document).ready(function(){
294 $('[data-toggle="popover"]').popover();
295});
296</script>
297```
298
299<script>
300$(document).ready(function(){
301 $('[data-toggle="popover"]').popover();
302});
303</script>
304
305```{r}
306popover_dt <- data.frame(
307 position = c("top", "bottom", "right", "left"),
308 stringsAsFactors = FALSE
309)
310popover_dt$`Hover over these items` <- cell_spec(
311 paste("Message on", popover_dt$position), # Cell texts
312 popover = spec_popover(
313 content = popover_dt$position,
314 title = NULL, # title will add a Title Panel on top
315 position = popover_dt$position
316 ))
Hao Zhu6107f372018-05-21 00:23:26 -0400317kable(popover_dt, escape = FALSE) %>%
Hao Zhu6f362bb2017-10-23 23:21:38 -0400318 kable_styling("striped", full_width = FALSE)
319```
320
321## Links
Hao Zhu9567e632017-10-24 09:51:09 -0400322You can add links to text via `text_spec("Google", link = "https://google.com")`: `r text_spec("Google", link = "https://google.com")`. 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.
323`text_spec("Hover on me", link = "javascript:void(0)", popover = "Hello")`:
324`r text_spec("Hover on me", link = "javascript:void(0)", popover = "Hello")`
Hao Zhu6f362bb2017-10-23 23:21:38 -0400325
Hao Zhu8b32b192017-10-24 14:51:48 -0400326## Integration with `formattable`
327You 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
328```{r, message = FALSE, warning=FALSE}
329library(formattable)
330mtcars[1:5, 1:4] %>%
331 mutate(
332 car = row.names(.),
333 mpg = color_tile("white", "orange")(mpg),
Hao Zhu6107f372018-05-21 00:23:26 -0400334 cyl = cell_spec(cyl, angle = (1:5)*60,
Hao Zhu8b32b192017-10-24 14:51:48 -0400335 background = "red", color = "white", align = "center"),
336 disp = ifelse(disp > 200,
Hao Zhu6107f372018-05-21 00:23:26 -0400337 cell_spec(disp, color = "red", bold = T),
338 cell_spec(disp, color = "green", italic = T)),
Hao Zhu8b32b192017-10-24 14:51:48 -0400339 hp = color_bar("lightgreen")(hp)
340 ) %>%
341 select(car, everything()) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400342 kable(escape = F) %>%
Hao Zhu8b32b192017-10-24 14:51:48 -0400343 kable_styling("hover", full_width = F) %>%
344 column_spec(5, width = "3cm") %>%
345 add_header_above(c(" ", "Hello" = 2, "World" = 2))
346```
347
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400348# Grouped Columns / Rows
349## Add header rows to group columns
Hao Zhu1fc48a62017-03-01 14:07:54 -0500350Tables 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)).
351```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400352kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500353 kable_styling("striped") %>%
354 add_header_above(c(" " = 1, "Group 1" = 2, "Group 2" = 2, "Group 3" = 2))
355```
356
Hao Zhu916c3662017-06-21 15:55:05 -0400357In fact, if you want to add another row of header on top, please feel free to do so.
Hao Zhu1fc48a62017-03-01 14:07:54 -0500358```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400359kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500360 kable_styling(c("striped", "bordered")) %>%
361 add_header_above(c(" ", "Group 1" = 2, "Group 2" = 2, "Group 3" = 2)) %>%
362 add_header_above(c(" ", "Group 4" = 4, "Group 5" = 2)) %>%
363 add_header_above(c(" ", "Group 6" = 6))
364```
365
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400366## Group rows via labeling
Hao Zhu72917f92019-03-15 18:41:42 -0400367Sometimes 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".
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400368```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400369kable(mtcars[1:10, 1:6], caption = "Group Rows") %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400370 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400371 pack_rows("Group 1", 4, 7) %>%
372 pack_rows("Group 2", 8, 10)
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400373```
374
Hao Zhu72917f92019-03-15 18:41:42 -0400375Another 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.
Hao Zhu4840bc92017-09-15 15:55:05 -0400376```{r, eval = F}
377# Not evaluated. This example generates the same table as above.
Hao Zhu6107f372018-05-21 00:23:26 -0400378kable(mtcars[1:10, 1:6], caption = "Group Rows") %>%
Hao Zhu4840bc92017-09-15 15:55:05 -0400379 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400380 pack_rows(index = c(" " = 3, "Group 1" = 4, "Group 2" = 3))
Hao Zhu4840bc92017-09-15 15:55:05 -0400381```
382
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400383For advanced users, you can even define your own css for the group labeling.
384```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400385kable(dt) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400386 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400387 pack_rows("Group 1", 3, 5, label_row_css = "background-color: #666; color: #fff;")
388```
389
390`r text_spec("Important Note!", bold = T, color = "#D7261E")`
391
392Note 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.**
393
394Alternatively, 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.
395
396```{r, eval=F}
397# Method 1
398pack_rows() # instead of group_rows()
399
400# Method 2
401library(dplyr)
402library(kableExtra)
403
404# Method 3
405conflicted::conflict_prefer("group_rows", "kableExtra", "dplyr")
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400406```
407
408## Row indentation
Hao Zhu72917f92019-03-15 18:41:42 -0400409Unlike `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 apporiate.
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400410For advanced users, you can even define your own css for the group labeling.
411```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400412kable(dt) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400413 kable_styling("striped", full_width = F) %>%
414 add_indent(c(1, 3, 5))
415```
416
417## Group rows via multi-row cell
Hao Zhu72917f92019-03-15 18:41:42 -0400418Function `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 allignment of the cell is controlled by `valign` with default as "top".
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400419
420```{r}
421collapse_rows_dt <- data.frame(C1 = c(rep("a", 10), rep("b", 5)),
422 C2 = c(rep("c", 7), rep("d", 3), rep("c", 2), rep("d", 3)),
423 C3 = 1:15,
424 C4 = sample(c(0,1), 15, replace = TRUE))
Hao Zhu6107f372018-05-21 00:23:26 -0400425kable(collapse_rows_dt, align = "c") %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400426 kable_styling(full_width = F) %>%
427 column_spec(1, bold = T) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400428 collapse_rows(columns = 1:2, valign = "top")
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400429```
430
431# Table Footnote
Hao Zhu1fc48a62017-03-01 14:07:54 -0500432
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500433> Now it's recommended to use the new `footnote` function instead of `add_footnote` to make table footnotes.
434
435Documentations for `add_footnote` can be found [here](http://haozhu233.github.io/kableExtra/legacy_features#add_footnote).
436
437There are four notation systems in `footnote`, namely `general`, `number`, `alphabet` and `symbol`. The last three types of footnotes will be labeled with corresponding marks while `general` won't be labeled. You can pick any one of these systems or choose to display them all for fulfill the APA table footnotes requirements.
Hao Zhu1fc48a62017-03-01 14:07:54 -0500438```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400439kable(dt, align = "c") %>%
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500440 kable_styling(full_width = F) %>%
441 footnote(general = "Here is a general comments of the table. ",
442 number = c("Footnote 1; ", "Footnote 2; "),
443 alphabet = c("Footnote A; ", "Footnote B; "),
444 symbol = c("Footnote Symbol 1; ", "Footnote Symbol 2")
445 )
Hao Zhu1fc48a62017-03-01 14:07:54 -0500446```
447
Hao Zhu6107f372018-05-21 00:23:26 -0400448You can also specify title for each category by using the `***_title` arguments. Default value for `general_title` is "Note: " and "" for the rest three. You can also change the order using `footnote_order`. You can even display footnote as chunk texts (default is as a list) using `footnote_as_chunk`. The font format of the titles are controlled by `title_format` with options including "italic" (default), "bold" and "underline".
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500449
Hao Zhu1fc48a62017-03-01 14:07:54 -0500450```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400451kable(dt, align = "c") %>%
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500452 kable_styling(full_width = F) %>%
453 footnote(general = "Here is a general comments of the table. ",
454 number = c("Footnote 1; ", "Footnote 2; "),
455 alphabet = c("Footnote A; ", "Footnote B; "),
456 symbol = c("Footnote Symbol 1; ", "Footnote Symbol 2"),
457 general_title = "General: ", number_title = "Type I: ",
458 alphabet_title = "Type II: ", symbol_title = "Type III: ",
Hao Zhu6107f372018-05-21 00:23:26 -0400459 footnote_as_chunk = T, title_format = c("italic", "underline")
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500460 )
Hao Zhu1fc48a62017-03-01 14:07:54 -0500461```
462
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500463If you need to add footnote marks in table, you need to do it manually (no fancy) using `footnote_mark_***()`. Remember that similar with `cell_spec`, you need to tell this function whether you want it to do it in `HTML` (default) or `LaTeX`. You can set it for all using the `knitr.table.format` global option. ALso, if you have ever use `footnote_mark_***()`, you need to put `escape = F` in your `kable` function to avoid escaping of special characters.
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400464
Hao Zhu1fc48a62017-03-01 14:07:54 -0500465```{r}
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500466dt_footnote <- dt
467names(dt_footnote)[2] <- paste0(names(dt_footnote)[2],
468 footnote_marker_symbol(1))
469row.names(dt_footnote)[4] <- paste0(row.names(dt_footnote)[4],
470 footnote_marker_alphabet(1))
Hao Zhu6107f372018-05-21 00:23:26 -0400471kable(dt_footnote, align = "c",
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500472 # Remember this escape = F
473 escape = F) %>%
474 kable_styling(full_width = F) %>%
475 footnote(alphabet = "Footnote A; ",
476 symbol = "Footnote Symbol 1; ",
477 alphabet_title = "Type II: ", symbol_title = "Type III: ",
478 footnote_as_chunk = T)
Hao Zhu1fc48a62017-03-01 14:07:54 -0500479```
Hao Zhuf9aa4c42017-05-22 15:53:35 -0400480
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400481# HTML Only Features
482## Scroll box
483If 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.
Hao Zhuf9aa4c42017-05-22 15:53:35 -0400484
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400485When 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.
Hao Zhu6ff9d502017-06-13 17:13:03 -0400486
487```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400488kable(cbind(mtcars, mtcars)) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400489 kable_styling() %>%
490 scroll_box(width = "500px", height = "200px")
Hao Zhu6ff9d502017-06-13 17:13:03 -0400491```
Irene62a3b362018-04-17 15:20:43 -0700492
493<br>
494
495You can also specify width using a percentage.
496
497```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400498kable(cbind(mtcars, mtcars)) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400499 add_header_above(c("a" = 5, "b" = 18)) %>%
Irene62a3b362018-04-17 15:20:43 -0700500 kable_styling() %>%
501 scroll_box(width = "100%", height = "200px")
502```
Hao Zhu6107f372018-05-21 00:23:26 -0400503
Hao Zhu72917f92019-03-15 18:41:42 -0400504Starting from version 1.1.0, if you have a fixed-height box, the header row is fixed
505
Hao Zhu6107f372018-05-21 00:23:26 -0400506## Save HTML table directly
507If you need to save those HTML tables but you don't want to generate them through rmarkdown, 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.
508```{r, eval=FALSE}
509kable(mtcars) %>%
510 kable_styling() %>%
511 save_kable(file = "table1.html", self_contained = T)
512```
513
514# From other packages
515Since the structure of `kable` is relatively simple, it shouldn't be too difficult to convert HTML or LaTeX tables generated by other packages to a `kable` object and then use `kableExtra` to modify the outputs. If you are a package author, feel free to reach out to me and we can collaborate.
516
517## `tables`
Hao Zhuec169362018-05-21 01:05:29 -0400518The latest version of [`tables`](https://CRAN.R-project.org/package=tables) comes with a `toKable()` function, which is compatiable with functions in `kableExtra` (>=0.9.0).
Hao Zhua171b452019-01-15 17:14:34 -0600519
520## `xtable`
521For `xtable` users, if you want to use `kableExtra` functions on that, check out this `xtable2kable()` function shipped with kableExtra 1.0.
522
523```{r, eval=F}
524# Not evaluating
525xtable::xtable(mtcars[1:4, 1:4], caption = "Hello xtable") %>%
526 xtable2kable() %>%
527 column_spec(1, color = "red")
528```