blob: d8ee3377e90499d1863d4aa9e3a75adbcbcedb94 [file] [log] [blame]
Hao Zhu6a076462017-03-01 12:59:01 -05001---
2title: "Create Awesome HTML Table with knitr::kable and kableExtra"
3author: "Hao Zhu"
4date: "`r Sys.Date()`"
5output:
6 html_document:
Hao Zhufd00fec2017-03-01 19:23:08 -05007 theme: simplex
Hao Zhu6a076462017-03-01 12:59:01 -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 Zhu53e240f2017-09-04 20:04: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 Zhu6a076462017-03-01 12:59:01 -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 Zhu53e240f2017-09-04 20:04:29 -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 Zhu6a076462017-03-01 12:59:01 -050028# Installation
Hao Zhu6a076462017-03-01 12:59:01 -050029```r
Hao Zhu74eb6ad2017-03-04 09:32:37 -050030install.packages("kableExtra")
31
Hao Zhu6a076462017-03-01 12:59:01 -050032# For dev version
Hao Zhuf9aa4c42017-05-22 15:53:35 -040033# install.packages("devtools")
Hao Zhu6a076462017-03-01 12:59:01 -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 Zhu6a076462017-03-01 12:59:01 -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 Zhu6a076462017-03-01 12:59:01 -050053## If you don't define format here, you'll need put `format = "html"` in every kable function.
54```
55
Hao Zhu53e240f2017-09-04 20:04:29 -040056## Basic HTML table
Hao Zhu6a076462017-03-01 12:59:01 -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 Zhu6a076462017-03-01 12:59:01 -050060```
61
Hao Zhu53e240f2017-09-04 20:04:29 -040062## Bootstrap theme
Hao Zhu6a076462017-03-01 12:59:01 -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 Zhu4840bc92017-09-15 15:55:05 -040065dt %>%
Hao Zhu6107f372018-05-21 00:23:26 -040066 kable() %>%
Hao Zhu6a076462017-03-01 12:59:01 -050067 kable_styling()
68```
69
70# Table Styles
Hao Zhu53e240f2017-09-04 20:04:29 -040071`kable_styling` offers a few other ways to customize the look of a HTML table.
Hao Zhu6a076462017-03-01 12:59:01 -050072
Hao Zhu53e240f2017-09-04 20:04:29 -040073## Bootstrap table classes
Hao Zhue2706b32017-03-07 02:36:17 -050074If 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 Zhu6a076462017-03-01 12:59:01 -050075
76For example, to add striped lines (alternative row colors) to your table and you want to highlight the hovered row, you can simply type:
77```{r}
Hao Zhu6107f372018-05-21 00:23:26 -040078kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -050079 kable_styling(bootstrap_options = c("striped", "hover"))
80```
81
82The 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.
83```{r}
Hao Zhu6107f372018-05-21 00:23:26 -040084kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -050085 kable_styling(bootstrap_options = c("striped", "hover", "condensed"))
86```
87
88Tables 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.
89```{r}
Hao Zhu6107f372018-05-21 00:23:26 -040090kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -050091 kable_styling(bootstrap_options = c("striped", "hover", "condensed", "responsive"))
92```
93
Hao Zhu53e240f2017-09-04 20:04:29 -040094## Full width?
Hao Zhuf9aa4c42017-05-22 15:53:35 -040095By 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 Zhu6a076462017-03-01 12:59:01 -050096```{r}
Hao Zhu6107f372018-05-21 00:23:26 -040097kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -050098 kable_styling(bootstrap_options = "striped", full_width = F)
99```
100
101## Position
102Table 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
103```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400104kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500105 kable_styling(bootstrap_options = "striped", full_width = F, position = "left")
106```
107
108Becides these three common options, you can also wrap text around the table using the `float-left` or `float-right` options.
109```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400110kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500111 kable_styling(bootstrap_options = "striped", full_width = F, position = "float_right")
112```
113Lorem 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.
114
Hao Zhu53e240f2017-09-04 20:04:29 -0400115## Font size
Hao Zhu6a076462017-03-01 12:59:01 -0500116If 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.
117```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400118kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500119 kable_styling(bootstrap_options = "striped", font_size = 7)
120```
121
Hao Zhu72917f92019-03-15 18:41:42 -0400122## Fixed Table Header Row
123If 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")`.
124
125```{r}
126kable(mtcars[1:10, 1:5]) %>%
127 kable_styling(fixed_thead = T)
128```
129
Hao Zhu53e240f2017-09-04 20:04:29 -0400130# Column / Row Specification
131## Column spec
Hao Zhu4840bc92017-09-15 15:55:05 -0400132When 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 Zhu53e240f2017-09-04 20:04:29 -0400133
134Warning: If you have a super long table, you should be cautious when you use `column_spec` as the xml node modification takes time.
135
136```{r}
137text_tbl <- data.frame(
138 Items = c("Item 1", "Item 2", "Item 3"),
139 Features = c(
140 "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vehicula tempor ex. Morbi malesuada sagittis turpis, at venenatis nisl luctus a. ",
141 "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. ",
142 "Vivamus venenatis egestas eros ut tempus. Vivamus id est nisi. Aliquam molestie erat et sollicitudin venenatis. In ac lacus at velit scelerisque mattis. "
143 )
144)
145
Hao Zhu6107f372018-05-21 00:23:26 -0400146kable(text_tbl) %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400147 kable_styling(full_width = F) %>%
Hao Zhufb0a6d42017-09-07 17:21:02 -0400148 column_spec(1, bold = T, border_right = T) %>%
149 column_spec(2, width = "30em", background = "yellow")
Hao Zhu53e240f2017-09-04 20:04:29 -0400150```
151
152
153## Row spec
154Similar 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.
155
156```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400157kable(dt) %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400158 kable_styling("striped", full_width = F) %>%
Hao Zhu4840bc92017-09-15 15:55:05 -0400159 column_spec(5:7, bold = T) %>%
160 row_spec(3:5, bold = T, color = "white", background = "#D7261E")
Hao Zhu53e240f2017-09-04 20:04:29 -0400161```
162
Hao Zhu6290fdd2017-10-24 00:10:32 -0400163
164
165## Header Rows
166One special case of `row_spec` is that you can specify the format of the header row via `row_spec(row = 0, ...)`.
167```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400168kable(dt) %>%
Hao Zhu6290fdd2017-10-24 00:10:32 -0400169 kable_styling("striped", full_width = F) %>%
170 row_spec(0, angle = -45)
171```
172
173# Cell/Text Specification
174Function `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:
Salim Bf2652cd2019-05-17 02:21:14 +0000175
Hao Zhu6290fdd2017-10-24 00:10:32 -0400176* 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
177* `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.
178
179Currently, `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.
180
181## Conditional logic
182It is very easy to use `cell_spec` with conditional logic. Here is an example.
183```{r, message=FALSE, warning=FALSE}
184library(dplyr)
185mtcars[1:10, 1:2] %>%
186 mutate(
187 car = row.names(.),
Hao Zhu72917f92019-03-15 18:41:42 -0400188 mpg = cell_spec(mpg, "html", color = ifelse(mpg > 20, "red", "blue")),
189 cyl = cell_spec(cyl, "html", color = "white", align = "c", angle = 45,
Hao Zhu6290fdd2017-10-24 00:10:32 -0400190 background = factor(cyl, c(4, 6, 8),
191 c("#666666", "#999999", "#BBBBBB")))
192 ) %>%
193 select(car, mpg, cyl) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400194 kable(format = "html", escape = F) %>%
Hao Zhu6290fdd2017-10-24 00:10:32 -0400195 kable_styling("striped", full_width = F)
196```
197
198## Visualize data with Viridis Color
Hao Zhu07305132017-10-24 15:41:49 -0400199This 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 Zhu6290fdd2017-10-24 00:10:32 -0400200
201```{r}
202iris[1:10, ] %>%
203 mutate_if(is.numeric, function(x) {
Hao Zhu6107f372018-05-21 00:23:26 -0400204 cell_spec(x, bold = T,
Hao Zhu5e4dd502018-04-05 12:01:58 -0400205 color = spec_color(x, end = 0.9),
Hao Zhu6290fdd2017-10-24 00:10:32 -0400206 font_size = spec_font_size(x))
207 }) %>%
208 mutate(Species = cell_spec(
Hao Zhu6107f372018-05-21 00:23:26 -0400209 Species, color = "white", bold = T,
Hao Zhu6290fdd2017-10-24 00:10:32 -0400210 background = spec_color(1:10, end = 0.9, option = "A", direction = -1)
211 )) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400212 kable(escape = F, align = "c") %>%
213 kable_styling(c("striped", "condensed"), full_width = F)
Hao Zhu6290fdd2017-10-24 00:10:32 -0400214```
215
216In 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.
217
218## Text Specification
219If 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.
220
221An aliased function `text_spec` is also provided for a more literal writing experience. In HTML, there is no difference between these two functions.
222
223```{r}
224sometext <- strsplit(paste0(
225 "You can even try to make some crazy things like this paragraph. ",
Hao Zhu6a1cbb52017-10-24 15:54:50 -0400226 "It may seem like a useless feature right now but it's so cool ",
227 "and nobody can resist. ;)"
Hao Zhu6290fdd2017-10-24 00:10:32 -0400228), " ")[[1]]
229text_formatted <- paste(
Hao Zhu6107f372018-05-21 00:23:26 -0400230 text_spec(sometext, color = spec_color(1:length(sometext), end = 0.9),
Hao Zhu6290fdd2017-10-24 00:10:32 -0400231 font_size = spec_font_size(1:length(sometext), begin = 5, end = 20)),
232 collapse = " ")
233
234# To display the text, type `r text_formatted` outside of the chunk
235```
236`r text_formatted`
237
238## Tooltip
239It'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).
240
241Note 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.
242```
243<script>
244$(document).ready(function(){
245 $('[data-toggle="tooltip"]').tooltip();
246});
247</script>
248```
249
250In 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.
251
252
253
254## Popover Message
255The 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.
256
257```
258<script>
259$(document).ready(function(){
260 $('[data-toggle="popover"]').popover();
261});
262</script>
263```
264
265<script>
266$(document).ready(function(){
267 $('[data-toggle="popover"]').popover();
268});
269</script>
270
271```{r}
272popover_dt <- data.frame(
273 position = c("top", "bottom", "right", "left"),
274 stringsAsFactors = FALSE
275)
276popover_dt$`Hover over these items` <- cell_spec(
277 paste("Message on", popover_dt$position), # Cell texts
278 popover = spec_popover(
279 content = popover_dt$position,
280 title = NULL, # title will add a Title Panel on top
281 position = popover_dt$position
282 ))
Hao Zhu6107f372018-05-21 00:23:26 -0400283kable(popover_dt, escape = FALSE) %>%
Hao Zhu6290fdd2017-10-24 00:10:32 -0400284 kable_styling("striped", full_width = FALSE)
285```
286
287## Links
Hao Zhu9567e632017-10-24 09:51:09 -0400288You 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.
289`text_spec("Hover on me", link = "javascript:void(0)", popover = "Hello")`:
290`r text_spec("Hover on me", link = "javascript:void(0)", popover = "Hello")`
Hao Zhu6290fdd2017-10-24 00:10:32 -0400291
Hao Zhu8b32b192017-10-24 14:51:48 -0400292## Integration with `formattable`
293You 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
294```{r, message = FALSE, warning=FALSE}
295library(formattable)
296mtcars[1:5, 1:4] %>%
297 mutate(
298 car = row.names(.),
299 mpg = color_tile("white", "orange")(mpg),
Hao Zhu6107f372018-05-21 00:23:26 -0400300 cyl = cell_spec(cyl, angle = (1:5)*60,
Hao Zhu8b32b192017-10-24 14:51:48 -0400301 background = "red", color = "white", align = "center"),
302 disp = ifelse(disp > 200,
Hao Zhu6107f372018-05-21 00:23:26 -0400303 cell_spec(disp, color = "red", bold = T),
304 cell_spec(disp, color = "green", italic = T)),
Hao Zhu8b32b192017-10-24 14:51:48 -0400305 hp = color_bar("lightgreen")(hp)
306 ) %>%
307 select(car, everything()) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400308 kable(escape = F) %>%
Hao Zhu8b32b192017-10-24 14:51:48 -0400309 kable_styling("hover", full_width = F) %>%
310 column_spec(5, width = "3cm") %>%
311 add_header_above(c(" ", "Hello" = 2, "World" = 2))
312```
313
Hao Zhu6290fdd2017-10-24 00:10:32 -0400314
Hao Zhu53e240f2017-09-04 20:04:29 -0400315# Grouped Columns / Rows
316## Add header rows to group columns
Hao Zhu6a076462017-03-01 12:59:01 -0500317Tables 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)).
318```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400319kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500320 kable_styling("striped") %>%
321 add_header_above(c(" " = 1, "Group 1" = 2, "Group 2" = 2, "Group 3" = 2))
322```
323
Hao Zhu4c4bf8d2017-07-03 19:38:11 -0400324In fact, if you want to add another row of header on top, please feel free to do so.
Hao Zhu6a076462017-03-01 12:59:01 -0500325```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400326kable(dt) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500327 kable_styling(c("striped", "bordered")) %>%
328 add_header_above(c(" ", "Group 1" = 2, "Group 2" = 2, "Group 3" = 2)) %>%
329 add_header_above(c(" ", "Group 4" = 4, "Group 5" = 2)) %>%
330 add_header_above(c(" ", "Group 6" = 6))
331```
332
Hao Zhu53e240f2017-09-04 20:04:29 -0400333## Group rows via labeling
Hao Zhu72917f92019-03-15 18:41:42 -0400334Sometimes 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 Zhu53e240f2017-09-04 20:04:29 -0400335```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400336kable(mtcars[1:10, 1:6], caption = "Group Rows") %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400337 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400338 pack_rows("Group 1", 4, 7) %>%
339 pack_rows("Group 2", 8, 10)
Hao Zhu53e240f2017-09-04 20:04:29 -0400340```
341
Hao Zhu72917f92019-03-15 18:41:42 -0400342Another 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 -0400343```{r, eval = F}
344# Not evaluated. This example generates the same table as above.
Hao Zhu6107f372018-05-21 00:23:26 -0400345kable(mtcars[1:10, 1:6], caption = "Group Rows") %>%
Hao Zhu4840bc92017-09-15 15:55:05 -0400346 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400347 pack_rows(index = c(" " = 3, "Group 1" = 4, "Group 2" = 3))
Hao Zhu4840bc92017-09-15 15:55:05 -0400348```
349
Hao Zhu53e240f2017-09-04 20:04:29 -0400350For advanced users, you can even define your own css for the group labeling.
351```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400352kable(dt) %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400353 kable_styling("striped", full_width = F) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400354 pack_rows("Group 1", 3, 5, label_row_css = "background-color: #666; color: #fff;")
355```
356
357`r text_spec("Important Note!", bold = T, color = "#D7261E")`
358
359Note 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.**
360
361Alternatively, 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.
362
363```{r, eval=F}
364# Method 1
365pack_rows() # instead of group_rows()
366
367# Method 2
368library(dplyr)
369library(kableExtra)
370
371# Method 3
372conflicted::conflict_prefer("group_rows", "kableExtra", "dplyr")
Hao Zhu53e240f2017-09-04 20:04:29 -0400373```
374
375## Row indentation
Hao Zhu72917f92019-03-15 18:41:42 -0400376Unlike `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 Zhu53e240f2017-09-04 20:04:29 -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 Zhu53e240f2017-09-04 20:04:29 -0400380 kable_styling("striped", full_width = F) %>%
381 add_indent(c(1, 3, 5))
382```
383
384## Group rows via multi-row cell
Hao Zhu72917f92019-03-15 18:41:42 -0400385Function `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 Zhu53e240f2017-09-04 20:04:29 -0400386
387```{r}
388collapse_rows_dt <- data.frame(C1 = c(rep("a", 10), rep("b", 5)),
389 C2 = c(rep("c", 7), rep("d", 3), rep("c", 2), rep("d", 3)),
390 C3 = 1:15,
391 C4 = sample(c(0,1), 15, replace = TRUE))
Hao Zhu6107f372018-05-21 00:23:26 -0400392kable(collapse_rows_dt, align = "c") %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400393 kable_styling(full_width = F) %>%
394 column_spec(1, bold = T) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400395 collapse_rows(columns = 1:2, valign = "top")
Hao Zhu53e240f2017-09-04 20:04:29 -0400396```
397
398# Table Footnote
Hao Zhu6a076462017-03-01 12:59:01 -0500399
Hao Zhub9da01c2018-01-14 21:01:57 -0500400> Now it's recommended to use the new `footnote` function instead of `add_footnote` to make table footnotes.
401
402Documentations for `add_footnote` can be found [here](http://haozhu233.github.io/kableExtra/legacy_features#add_footnote).
403
404There 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 Zhu6a076462017-03-01 12:59:01 -0500405```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400406kable(dt, align = "c") %>%
Hao Zhub9da01c2018-01-14 21:01:57 -0500407 kable_styling(full_width = F) %>%
408 footnote(general = "Here is a general comments of the table. ",
409 number = c("Footnote 1; ", "Footnote 2; "),
410 alphabet = c("Footnote A; ", "Footnote B; "),
411 symbol = c("Footnote Symbol 1; ", "Footnote Symbol 2")
412 )
Hao Zhu6a076462017-03-01 12:59:01 -0500413```
414
Hao Zhu6107f372018-05-21 00:23:26 -0400415You 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 Zhub9da01c2018-01-14 21:01:57 -0500416
Hao Zhu6a076462017-03-01 12:59:01 -0500417```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400418kable(dt, align = "c") %>%
Hao Zhub9da01c2018-01-14 21:01:57 -0500419 kable_styling(full_width = F) %>%
420 footnote(general = "Here is a general comments of the table. ",
421 number = c("Footnote 1; ", "Footnote 2; "),
422 alphabet = c("Footnote A; ", "Footnote B; "),
423 symbol = c("Footnote Symbol 1; ", "Footnote Symbol 2"),
424 general_title = "General: ", number_title = "Type I: ",
425 alphabet_title = "Type II: ", symbol_title = "Type III: ",
Hao Zhu6107f372018-05-21 00:23:26 -0400426 footnote_as_chunk = T, title_format = c("italic", "underline")
Hao Zhub9da01c2018-01-14 21:01:57 -0500427 )
Hao Zhu6a076462017-03-01 12:59:01 -0500428```
429
Hao Zhub9da01c2018-01-14 21:01:57 -0500430If 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 Zhu53e240f2017-09-04 20:04:29 -0400431
Hao Zhu6a076462017-03-01 12:59:01 -0500432```{r}
Hao Zhub9da01c2018-01-14 21:01:57 -0500433dt_footnote <- dt
434names(dt_footnote)[2] <- paste0(names(dt_footnote)[2],
435 footnote_marker_symbol(1))
436row.names(dt_footnote)[4] <- paste0(row.names(dt_footnote)[4],
437 footnote_marker_alphabet(1))
Hao Zhu6107f372018-05-21 00:23:26 -0400438kable(dt_footnote, align = "c",
Hao Zhub9da01c2018-01-14 21:01:57 -0500439 # Remember this escape = F
440 escape = F) %>%
441 kable_styling(full_width = F) %>%
442 footnote(alphabet = "Footnote A; ",
443 symbol = "Footnote Symbol 1; ",
444 alphabet_title = "Type II: ", symbol_title = "Type III: ",
445 footnote_as_chunk = T)
Hao Zhu6a076462017-03-01 12:59:01 -0500446```
Hao Zhuf9aa4c42017-05-22 15:53:35 -0400447
Hao Zhu53e240f2017-09-04 20:04:29 -0400448# HTML Only Features
449## Scroll box
450If 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 -0400451
Hao Zhu53e240f2017-09-04 20:04:29 -0400452When 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 Zhu4c4bf8d2017-07-03 19:38:11 -0400453
454```{r}
Hao Zhu6107f372018-05-21 00:23:26 -0400455kable(cbind(mtcars, mtcars)) %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400456 kable_styling() %>%
457 scroll_box(width = "500px", height = "200px")
Hao Zhu4c4bf8d2017-07-03 19:38:11 -0400458```
Hao Zhu6107f372018-05-21 00:23:26 -0400459
460<br>
461
462You can also specify width using a percentage.
463
464```{r}
465kable(cbind(mtcars, mtcars)) %>%
Hao Zhu72917f92019-03-15 18:41:42 -0400466 add_header_above(c("a" = 5, "b" = 18)) %>%
Hao Zhu6107f372018-05-21 00:23:26 -0400467 kable_styling() %>%
468 scroll_box(width = "100%", height = "200px")
469```
470
Hao Zhu72917f92019-03-15 18:41:42 -0400471Starting from version 1.1.0, if you have a fixed-height box, the header row is fixed
472
Hao Zhu6107f372018-05-21 00:23:26 -0400473## Save HTML table directly
474If 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.
475```{r, eval=FALSE}
476kable(mtcars) %>%
477 kable_styling() %>%
478 save_kable(file = "table1.html", self_contained = T)
479```
480
481# From other packages
482Since 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.
483
484## `tables`
Hao Zhuec169362018-05-21 01:05:29 -0400485The 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 -0600486
487## `xtable`
488For `xtable` users, if you want to use `kableExtra` functions on that, check out this `xtable2kable()` function shipped with kableExtra 1.0.
489
490```{r, eval=F}
491# Not evaluating
492xtable::xtable(mtcars[1:4, 1:4], caption = "Hello xtable") %>%
493 xtable2kable() %>%
494 column_spec(1, color = "red")
495```