blob: a434ce16b3ce4b11e5d3fd9146662f0a2f0efa18 [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 Zhu9bf19982020-08-11 00:50:33 -040071`kableExtra` also offers a few in-house alternative HTML table themes other than the default bootstrap theme. Right now there are three of them: `kable_classic`, `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() %>%
82 kable_minimal()
83```
84
85```{r}
86dt %>%
87 kable() %>%
88 kable_material(c("striped", "hover"))
89```
90
Hao Zhu9bf19982020-08-11 00:50:33 -040091```{r}
92dt %>%
93 kable() %>%
94 kable_material_dark()
95```
96
Hao Zhud7762a42020-08-10 09:05:47 -040097
98
Hao Zhu1fc48a62017-03-01 14:07:54 -050099# Table Styles
Hao Zhu462b4492017-08-03 11:31:42 -0400100`kable_styling` offers a few other ways to customize the look of a HTML table.
Hao Zhu1fc48a62017-03-01 14:07:54 -0500101
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400102## Bootstrap table classes
Hao Zhue2706b32017-03-07 02:36:17 -0500103If 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 -0500104
105For example, to add striped lines (alternative row colors) to your table and you want to highlight the hovered row, you can simply type:
106```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400107kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500108 kable_styling(bootstrap_options = c("striped", "hover"))
109```
110
111The 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.
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", "condensed"))
115```
116
117Tables 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.
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", "responsive"))
121```
122
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400123## Full width?
Hao Zhubf4cdc62017-03-02 22:26:29 -0500124By 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 -0500125```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400126kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500127 kable_styling(bootstrap_options = "striped", full_width = F)
128```
129
130## Position
131Table 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
132```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400133kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500134 kable_styling(bootstrap_options = "striped", full_width = F, position = "left")
135```
136
137Becides these three common options, you can also wrap text around the table using the `float-left` or `float-right` options.
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 = "float_right")
141```
142Lorem 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.
143
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400144## Font size
Hao Zhu1fc48a62017-03-01 14:07:54 -0500145If 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.
146```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400147kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500148 kable_styling(bootstrap_options = "striped", font_size = 7)
149```
150
Hao Zhu72917f92019-03-15 18:41:42 -0400151## Fixed Table Header Row
152If 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")`.
153
154```{r}
155kable(mtcars[1:10, 1:5]) %>%
156 kable_styling(fixed_thead = T)
157```
158
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400159# Column / Row Specification
160## Column spec
Hao Zhu4840bc92017-09-15 15:55:05 -0400161When 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 -0400162
163Warning: If you have a super long table, you should be cautious when you use `column_spec` as the xml node modification takes time.
164
165```{r}
166text_tbl <- data.frame(
167 Items = c("Item 1", "Item 2", "Item 3"),
168 Features = c(
169 "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vehicula tempor ex. Morbi malesuada sagittis turpis, at venenatis nisl luctus a. ",
170 "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. ",
171 "Vivamus venenatis egestas eros ut tempus. Vivamus id est nisi. Aliquam molestie erat et sollicitudin venenatis. In ac lacus at velit scelerisque mattis. "
172 )
173)
174
Hao Zhu6107f372018-05-21 00:23:26 -0400175kable(text_tbl) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400176 kable_styling(full_width = F) %>%
Hao Zhua44e3752017-09-05 12:56:19 -0400177 column_spec(1, bold = T, border_right = T) %>%
178 column_spec(2, width = "30em", background = "yellow")
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400179```
180
181
Hao Zhu0a0e8332017-08-03 13:21:29 -0400182## Row spec
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400183Similar 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.
184
185```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400186kable(dt) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400187 kable_styling("striped", full_width = F) %>%
Hao Zhu4840bc92017-09-15 15:55:05 -0400188 column_spec(5:7, bold = T) %>%
189 row_spec(3:5, bold = T, color = "white", background = "#D7261E")
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400190```
191
Hao Zhu9ce317e2017-10-12 18:19:55 -0400192
Hao Zhu6f362bb2017-10-23 23:21:38 -0400193
194## Header Rows
195One special case of `row_spec` is that you can specify the format of the header row via `row_spec(row = 0, ...)`.
196```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400197kable(dt) %>%
Hao Zhu6f362bb2017-10-23 23:21:38 -0400198 kable_styling("striped", full_width = F) %>%
199 row_spec(0, angle = -45)
Hao Zhu9ce317e2017-10-12 18:19:55 -0400200```
201
Hao Zhu6f362bb2017-10-23 23:21:38 -0400202# Cell/Text Specification
203Function `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:
204* 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
205* `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.
206
207Currently, `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.
208
209## Conditional logic
210It is very easy to use `cell_spec` with conditional logic. Here is an example.
211```{r, message=FALSE, warning=FALSE}
212library(dplyr)
213mtcars[1:10, 1:2] %>%
214 mutate(
215 car = row.names(.),
Hao Zhu76762d82018-07-25 20:56:52 -0400216 mpg = cell_spec(mpg, "html", color = ifelse(mpg > 20, "red", "blue")),
217 cyl = cell_spec(cyl, "html", color = "white", align = "c", angle = 45,
Hao Zhu6f362bb2017-10-23 23:21:38 -0400218 background = factor(cyl, c(4, 6, 8),
219 c("#666666", "#999999", "#BBBBBB")))
220 ) %>%
221 select(car, mpg, cyl) %>%
Hao Zhu76762d82018-07-25 20:56:52 -0400222 kable(format = "html", escape = F) %>%
Hao Zhu6f362bb2017-10-23 23:21:38 -0400223 kable_styling("striped", full_width = F)
224```
225
226## Visualize data with Viridis Color
Hao Zhu07305132017-10-24 15:41:49 -0400227This 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 -0400228
229```{r}
230iris[1:10, ] %>%
231 mutate_if(is.numeric, function(x) {
Hao Zhu6107f372018-05-21 00:23:26 -0400232 cell_spec(x, bold = T,
Hao Zhu5ece06e2018-01-19 23:18:02 -0500233 color = spec_color(x, end = 0.9),
Hao Zhu6f362bb2017-10-23 23:21:38 -0400234 font_size = spec_font_size(x))
235 }) %>%
236 mutate(Species = cell_spec(
Hao Zhu6107f372018-05-21 00:23:26 -0400237 Species, color = "white", bold = T,
Hao Zhu6f362bb2017-10-23 23:21:38 -0400238 background = spec_color(1:10, end = 0.9, option = "A", direction = -1)
239 )) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400240 kable(escape = F, align = "c") %>%
Hao Zhu222cd7e2018-04-10 14:27:19 -0400241 kable_styling(c("striped", "condensed"), full_width = F)
Hao Zhu6f362bb2017-10-23 23:21:38 -0400242```
243
244In 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.
245
246## Text Specification
247If 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.
248
249An aliased function `text_spec` is also provided for a more literal writing experience. In HTML, there is no difference between these two functions.
250
251```{r}
252sometext <- strsplit(paste0(
Hao Zhu6290fdd2017-10-24 00:10:32 -0400253 "You can even try to make some crazy things like this paragraph. ",
Hao Zhu6a1cbb52017-10-24 15:54:50 -0400254 "It may seem like a useless feature right now but it's so cool ",
255 "and nobody can resist. ;)"
Hao Zhu6f362bb2017-10-23 23:21:38 -0400256), " ")[[1]]
257text_formatted <- paste(
Hao Zhu6107f372018-05-21 00:23:26 -0400258 text_spec(sometext, color = spec_color(1:length(sometext), end = 0.9),
Hao Zhu6f362bb2017-10-23 23:21:38 -0400259 font_size = spec_font_size(1:length(sometext), begin = 5, end = 20)),
260 collapse = " ")
261
262# To display the text, type `r text_formatted` outside of the chunk
263```
264`r text_formatted`
265
266## Tooltip
267It'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).
268
269Note 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.
270```
271<script>
272$(document).ready(function(){
273 $('[data-toggle="tooltip"]').tooltip();
274});
275</script>
276```
277
278In 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.
279
280
281
282## Popover Message
283The 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.
284
285```
286<script>
287$(document).ready(function(){
288 $('[data-toggle="popover"]').popover();
289});
290</script>
291```
292
293<script>
294$(document).ready(function(){
295 $('[data-toggle="popover"]').popover();
296});
297</script>
298
299```{r}
300popover_dt <- data.frame(
301 position = c("top", "bottom", "right", "left"),
302 stringsAsFactors = FALSE
303)
304popover_dt$`Hover over these items` <- cell_spec(
305 paste("Message on", popover_dt$position), # Cell texts
306 popover = spec_popover(
307 content = popover_dt$position,
308 title = NULL, # title will add a Title Panel on top
309 position = popover_dt$position
310 ))
Hao Zhu6107f372018-05-21 00:23:26 -0400311kable(popover_dt, escape = FALSE) %>%
Hao Zhu6f362bb2017-10-23 23:21:38 -0400312 kable_styling("striped", full_width = FALSE)
313```
314
315## Links
Hao Zhu9567e632017-10-24 09:51:09 -0400316You 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.
317`text_spec("Hover on me", link = "javascript:void(0)", popover = "Hello")`:
318`r text_spec("Hover on me", link = "javascript:void(0)", popover = "Hello")`
Hao Zhu6f362bb2017-10-23 23:21:38 -0400319
Hao Zhu8b32b192017-10-24 14:51:48 -0400320## Integration with `formattable`
321You 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
322```{r, message = FALSE, warning=FALSE}
323library(formattable)
324mtcars[1:5, 1:4] %>%
325 mutate(
326 car = row.names(.),
327 mpg = color_tile("white", "orange")(mpg),
Hao Zhu6107f372018-05-21 00:23:26 -0400328 cyl = cell_spec(cyl, angle = (1:5)*60,
Hao Zhu8b32b192017-10-24 14:51:48 -0400329 background = "red", color = "white", align = "center"),
330 disp = ifelse(disp > 200,
Hao Zhu6107f372018-05-21 00:23:26 -0400331 cell_spec(disp, color = "red", bold = T),
332 cell_spec(disp, color = "green", italic = T)),
Hao Zhu8b32b192017-10-24 14:51:48 -0400333 hp = color_bar("lightgreen")(hp)
334 ) %>%
335 select(car, everything()) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400336 kable(escape = F) %>%
Hao Zhu8b32b192017-10-24 14:51:48 -0400337 kable_styling("hover", full_width = F) %>%
338 column_spec(5, width = "3cm") %>%
339 add_header_above(c(" ", "Hello" = 2, "World" = 2))
340```
341
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400342# Grouped Columns / Rows
343## Add header rows to group columns
Hao Zhu1fc48a62017-03-01 14:07:54 -0500344Tables 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)).
345```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400346kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500347 kable_styling("striped") %>%
348 add_header_above(c(" " = 1, "Group 1" = 2, "Group 2" = 2, "Group 3" = 2))
349```
350
Hao Zhu916c3662017-06-21 15:55:05 -0400351In 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 -0500352```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400353kable(dt) %>%
Hao Zhu1fc48a62017-03-01 14:07:54 -0500354 kable_styling(c("striped", "bordered")) %>%
355 add_header_above(c(" ", "Group 1" = 2, "Group 2" = 2, "Group 3" = 2)) %>%
356 add_header_above(c(" ", "Group 4" = 4, "Group 5" = 2)) %>%
357 add_header_above(c(" ", "Group 6" = 6))
358```
359
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400360## Group rows via labeling
Hao Zhu72917f92019-03-15 18:41:42 -0400361Sometimes 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 -0400362```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400363kable(mtcars[1:10, 1:6], caption = "Group Rows") %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400364 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400365 pack_rows("Group 1", 4, 7) %>%
366 pack_rows("Group 2", 8, 10)
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400367```
368
Hao Zhu72917f92019-03-15 18:41:42 -0400369Another 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 -0400370```{r, eval = F}
371# Not evaluated. This example generates the same table as above.
Hao Zhu6107f372018-05-21 00:23:26 -0400372kable(mtcars[1:10, 1:6], caption = "Group Rows") %>%
Hao Zhu4840bc92017-09-15 15:55:05 -0400373 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400374 pack_rows(index = c(" " = 3, "Group 1" = 4, "Group 2" = 3))
Hao Zhu4840bc92017-09-15 15:55:05 -0400375```
376
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400377For advanced users, you can even define your own css for the group labeling.
378```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400379kable(dt) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400380 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400381 pack_rows("Group 1", 3, 5, label_row_css = "background-color: #666; color: #fff;")
382```
383
384`r text_spec("Important Note!", bold = T, color = "#D7261E")`
385
386Note 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.**
387
388Alternatively, 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.
389
390```{r, eval=F}
391# Method 1
392pack_rows() # instead of group_rows()
393
394# Method 2
395library(dplyr)
396library(kableExtra)
397
398# Method 3
399conflicted::conflict_prefer("group_rows", "kableExtra", "dplyr")
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400400```
401
402## Row indentation
Hao Zhu72917f92019-03-15 18:41:42 -0400403Unlike `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 -0400404For advanced users, you can even define your own css for the group labeling.
405```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400406kable(dt) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400407 kable_styling("striped", full_width = F) %>%
408 add_indent(c(1, 3, 5))
409```
410
411## Group rows via multi-row cell
Hao Zhu72917f92019-03-15 18:41:42 -0400412Function `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 -0400413
414```{r}
415collapse_rows_dt <- data.frame(C1 = c(rep("a", 10), rep("b", 5)),
416 C2 = c(rep("c", 7), rep("d", 3), rep("c", 2), rep("d", 3)),
417 C3 = 1:15,
418 C4 = sample(c(0,1), 15, replace = TRUE))
Hao Zhu6107f372018-05-21 00:23:26 -0400419kable(collapse_rows_dt, align = "c") %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400420 kable_styling(full_width = F) %>%
421 column_spec(1, bold = T) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400422 collapse_rows(columns = 1:2, valign = "top")
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400423```
424
425# Table Footnote
Hao Zhu1fc48a62017-03-01 14:07:54 -0500426
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500427> Now it's recommended to use the new `footnote` function instead of `add_footnote` to make table footnotes.
428
429Documentations for `add_footnote` can be found [here](http://haozhu233.github.io/kableExtra/legacy_features#add_footnote).
430
431There 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 -0500432```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400433kable(dt, align = "c") %>%
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500434 kable_styling(full_width = F) %>%
435 footnote(general = "Here is a general comments of the table. ",
436 number = c("Footnote 1; ", "Footnote 2; "),
437 alphabet = c("Footnote A; ", "Footnote B; "),
438 symbol = c("Footnote Symbol 1; ", "Footnote Symbol 2")
439 )
Hao Zhu1fc48a62017-03-01 14:07:54 -0500440```
441
Hao Zhu6107f372018-05-21 00:23:26 -0400442You 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 -0500443
Hao Zhu1fc48a62017-03-01 14:07:54 -0500444```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400445kable(dt, align = "c") %>%
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500446 kable_styling(full_width = F) %>%
447 footnote(general = "Here is a general comments of the table. ",
448 number = c("Footnote 1; ", "Footnote 2; "),
449 alphabet = c("Footnote A; ", "Footnote B; "),
450 symbol = c("Footnote Symbol 1; ", "Footnote Symbol 2"),
451 general_title = "General: ", number_title = "Type I: ",
452 alphabet_title = "Type II: ", symbol_title = "Type III: ",
Hao Zhu6107f372018-05-21 00:23:26 -0400453 footnote_as_chunk = T, title_format = c("italic", "underline")
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500454 )
Hao Zhu1fc48a62017-03-01 14:07:54 -0500455```
456
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500457If 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 -0400458
Hao Zhu1fc48a62017-03-01 14:07:54 -0500459```{r}
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500460dt_footnote <- dt
461names(dt_footnote)[2] <- paste0(names(dt_footnote)[2],
462 footnote_marker_symbol(1))
463row.names(dt_footnote)[4] <- paste0(row.names(dt_footnote)[4],
464 footnote_marker_alphabet(1))
Hao Zhu6107f372018-05-21 00:23:26 -0400465kable(dt_footnote, align = "c",
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500466 # Remember this escape = F
467 escape = F) %>%
468 kable_styling(full_width = F) %>%
469 footnote(alphabet = "Footnote A; ",
470 symbol = "Footnote Symbol 1; ",
471 alphabet_title = "Type II: ", symbol_title = "Type III: ",
472 footnote_as_chunk = T)
Hao Zhu1fc48a62017-03-01 14:07:54 -0500473```
Hao Zhuf9aa4c42017-05-22 15:53:35 -0400474
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400475# HTML Only Features
476## Scroll box
477If 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 -0400478
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400479When 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 -0400480
481```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400482kable(cbind(mtcars, mtcars)) %>%
Hao Zhu4b0c51e2017-08-01 15:21:07 -0400483 kable_styling() %>%
484 scroll_box(width = "500px", height = "200px")
Hao Zhu6ff9d502017-06-13 17:13:03 -0400485```
Irene62a3b362018-04-17 15:20:43 -0700486
487<br>
488
489You can also specify width using a percentage.
490
491```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400492kable(cbind(mtcars, mtcars)) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400493 add_header_above(c("a" = 5, "b" = 18)) %>%
Irene62a3b362018-04-17 15:20:43 -0700494 kable_styling() %>%
495 scroll_box(width = "100%", height = "200px")
496```
Hao Zhu6107f372018-05-21 00:23:26 -0400497
Hao Zhu72917f92019-03-15 18:41:42 -0400498Starting from version 1.1.0, if you have a fixed-height box, the header row is fixed
499
Hao Zhu6107f372018-05-21 00:23:26 -0400500## Save HTML table directly
501If 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.
502```{r, eval=FALSE}
503kable(mtcars) %>%
504 kable_styling() %>%
505 save_kable(file = "table1.html", self_contained = T)
506```
507
508# From other packages
509Since 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.
510
511## `tables`
Hao Zhuec169362018-05-21 01:05:29 -0400512The 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 -0600513
514## `xtable`
515For `xtable` users, if you want to use `kableExtra` functions on that, check out this `xtable2kable()` function shipped with kableExtra 1.0.
516
517```{r, eval=F}
518# Not evaluating
519xtable::xtable(mtcars[1:4, 1:4], caption = "Hello xtable") %>%
520 xtable2kable() %>%
521 column_spec(1, color = "red")
522```