blob: e042f653b8d430a7cbe41ee616419aa67c2616e3 [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 Zhu53e240f2017-09-04 20:04:29 -040017> 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 -040018
Hao Zhu6a076462017-03-01 12:59:01 -050019# Overview
20The 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`.
21
Hao Zhu53e240f2017-09-04 20:04:29 -040022To 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)
23
Hao Zhu6a076462017-03-01 12:59:01 -050024# Installation
Hao Zhu6a076462017-03-01 12:59:01 -050025```r
Hao Zhu74eb6ad2017-03-04 09:32:37 -050026install.packages("kableExtra")
27
Hao Zhu6a076462017-03-01 12:59:01 -050028# For dev version
Hao Zhuf9aa4c42017-05-22 15:53:35 -040029# install.packages("devtools")
Hao Zhu6a076462017-03-01 12:59:01 -050030devtools::install_github("haozhu233/kableExtra")
31```
32# Getting Started
33Here we are using the first few columns and rows from dataset `mtcars`
34```{r}
35library(knitr)
36library(kableExtra)
37dt <- mtcars[1:5, 1:6]
38```
39
Hao Zhu4840bc92017-09-15 15:55:05 -040040When 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.* **In this tutorial, I'll still put `format="html"` in the function in case users just want to quickly replicate the results.**
Hao Zhu6a076462017-03-01 12:59:01 -050041
42```{r}
43options(knitr.table.format = "html")
44## If you don't define format here, you'll need put `format = "html"` in every kable function.
45```
46
Hao Zhu53e240f2017-09-04 20:04:29 -040047## Basic HTML table
Hao Zhu6a076462017-03-01 12:59:01 -050048Basic HTML output of `kable` looks very crude. To the end, it's just a plain HTML table without any love from css.
49```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -040050kable(dt, "html")
Hao Zhu6a076462017-03-01 12:59:01 -050051```
52
Hao Zhu53e240f2017-09-04 20:04:29 -040053## Bootstrap theme
Hao Zhu6a076462017-03-01 12:59:01 -050054When 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.
55```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -040056dt %>%
57 kable("html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -050058 kable_styling()
59```
60
61# Table Styles
Hao Zhu53e240f2017-09-04 20:04:29 -040062`kable_styling` offers a few other ways to customize the look of a HTML table.
Hao Zhu6a076462017-03-01 12:59:01 -050063
Hao Zhu53e240f2017-09-04 20:04:29 -040064## Bootstrap table classes
Hao Zhue2706b32017-03-07 02:36:17 -050065If 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 -050066
67For example, to add striped lines (alternative row colors) to your table and you want to highlight the hovered row, you can simply type:
68```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -040069kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -050070 kable_styling(bootstrap_options = c("striped", "hover"))
71```
72
73The 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.
74```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -040075kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -050076 kable_styling(bootstrap_options = c("striped", "hover", "condensed"))
77```
78
79Tables 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.
80```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -040081kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -050082 kable_styling(bootstrap_options = c("striped", "hover", "condensed", "responsive"))
83```
84
Hao Zhu53e240f2017-09-04 20:04:29 -040085## Full width?
Hao Zhuf9aa4c42017-05-22 15:53:35 -040086By 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 -050087```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -040088kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -050089 kable_styling(bootstrap_options = "striped", full_width = F)
90```
91
92## Position
93Table 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
94```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -040095kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -050096 kable_styling(bootstrap_options = "striped", full_width = F, position = "left")
97```
98
99Becides these three common options, you can also wrap text around the table using the `float-left` or `float-right` options.
100```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400101kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500102 kable_styling(bootstrap_options = "striped", full_width = F, position = "float_right")
103```
104Lorem 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.
105
Hao Zhu53e240f2017-09-04 20:04:29 -0400106## Font size
Hao Zhu6a076462017-03-01 12:59:01 -0500107If 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.
108```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400109kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500110 kable_styling(bootstrap_options = "striped", font_size = 7)
111```
112
Hao Zhu53e240f2017-09-04 20:04:29 -0400113# Column / Row Specification
114## Column spec
Hao Zhu4840bc92017-09-15 15:55:05 -0400115When 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 -0400116
117Warning: If you have a super long table, you should be cautious when you use `column_spec` as the xml node modification takes time.
118
119```{r}
120text_tbl <- data.frame(
121 Items = c("Item 1", "Item 2", "Item 3"),
122 Features = c(
123 "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vehicula tempor ex. Morbi malesuada sagittis turpis, at venenatis nisl luctus a. ",
124 "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. ",
125 "Vivamus venenatis egestas eros ut tempus. Vivamus id est nisi. Aliquam molestie erat et sollicitudin venenatis. In ac lacus at velit scelerisque mattis. "
126 )
127)
128
Hao Zhu4840bc92017-09-15 15:55:05 -0400129kable(text_tbl, "html") %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400130 kable_styling(full_width = F) %>%
Hao Zhufb0a6d42017-09-07 17:21:02 -0400131 column_spec(1, bold = T, border_right = T) %>%
132 column_spec(2, width = "30em", background = "yellow")
Hao Zhu53e240f2017-09-04 20:04:29 -0400133```
134
135
136## Row spec
137Similar 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.
138
139```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400140kable(dt, "html") %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400141 kable_styling("striped", full_width = F) %>%
Hao Zhu4840bc92017-09-15 15:55:05 -0400142 column_spec(5:7, bold = T) %>%
143 row_spec(3:5, bold = T, color = "white", background = "#D7261E")
Hao Zhu53e240f2017-09-04 20:04:29 -0400144```
145
146# Grouped Columns / Rows
147## Add header rows to group columns
Hao Zhu6a076462017-03-01 12:59:01 -0500148Tables 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)).
149```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400150kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500151 kable_styling("striped") %>%
152 add_header_above(c(" " = 1, "Group 1" = 2, "Group 2" = 2, "Group 3" = 2))
153```
154
Hao Zhu4c4bf8d2017-07-03 19:38:11 -0400155In 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 -0500156```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400157kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500158 kable_styling(c("striped", "bordered")) %>%
159 add_header_above(c(" ", "Group 1" = 2, "Group 2" = 2, "Group 3" = 2)) %>%
160 add_header_above(c(" ", "Group 4" = 4, "Group 5" = 2)) %>%
161 add_header_above(c(" ", "Group 6" = 6))
162```
163
Hao Zhu53e240f2017-09-04 20:04:29 -0400164## Group rows via labeling
165Sometimes 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 new function `group_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".
166```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400167kable(mtcars[1:10, 1:6], "html", caption = "Group Rows") %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400168 kable_styling("striped", full_width = F) %>%
169 group_rows("Group 1", 4, 7) %>%
170 group_rows("Group 2", 8, 10)
171```
172
Hao Zhu4840bc92017-09-15 15:55:05 -0400173Another way to use `group_rows` is to provide an grouping index, similar with `add_header_above()`. This feature is only available in kableExtra > 0.5.2.
174```{r, eval = F}
175# Not evaluated. This example generates the same table as above.
176kable(mtcars[1:10, 1:6], "html", caption = "Group Rows") %>%
177 kable_styling("striped", full_width = F) %>%
178 group_rows(index = c(" " = 3, "Group 1" = 4, "Group 2" = 3))
179```
180
Hao Zhu53e240f2017-09-04 20:04:29 -0400181For advanced users, you can even define your own css for the group labeling.
182```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400183kable(dt, "html") %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400184 kable_styling("striped", full_width = F) %>%
185 group_rows("Group 1", 3, 5, label_row_css = "background-color: #666; color: #fff;")
186```
187
188## Row indentation
189Unlike `group_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.
190For advanced users, you can even define your own css for the group labeling.
191```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400192kable(dt, "html") %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400193 kable_styling("striped", full_width = F) %>%
194 add_indent(c(1, 3, 5))
195```
196
197## Group rows via multi-row cell
198Function `group_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.
199
200```{r}
201collapse_rows_dt <- data.frame(C1 = c(rep("a", 10), rep("b", 5)),
202 C2 = c(rep("c", 7), rep("d", 3), rep("c", 2), rep("d", 3)),
203 C3 = 1:15,
204 C4 = sample(c(0,1), 15, replace = TRUE))
205kable(collapse_rows_dt, "html", align = "c") %>%
206 kable_styling(full_width = F) %>%
207 column_spec(1, bold = T) %>%
208 collapse_rows(columns = 1:2)
209```
210
211# Table Footnote
212## Notation systems
Hao Zhu6a076462017-03-01 12:59:01 -0500213You can also use `add_footnote()` function from this package. You will need to supply a character vector with each element as one footnote. You may select from `number`, `alphabet` and `symbol` for different types of notations. Example are listed below.
214
215### Alphabet
216```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400217kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500218 kable_styling("striped") %>%
219 add_footnote(c("Footnote 1", "Have a good day."), notation = "alphabet")
220```
221
222### Number
223```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400224kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500225 kable_styling("striped") %>%
226 add_footnote(c("Footnote 1", "Have a good day."), notation = "number")
227```
228
229### Symbol
230```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400231kable(dt, "html") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500232 kable_styling("striped") %>%
233 add_footnote(c("Footnote 1", "Footnote 2", "Footnote 3"), notation = "symbol")
234```
235
236## In-table markers
237By design, `add_footnote()` will transform any `[note]` to in-table footnote markers.
Hao Zhu53e240f2017-09-04 20:04:29 -0400238
Hao Zhu6a076462017-03-01 12:59:01 -0500239```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400240kable(dt, "html", caption = "Demo Table[note]") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500241 kable_styling("striped") %>%
242 add_header_above(c(" ", "Group 1[note]" = 3, "Group 2[note]" = 3)) %>%
243 add_footnote(c("This table is from mtcars",
244 "Group 1 contains mpg, cyl and disp",
245 "Group 2 contains hp, drat and wt"),
246 notation = "symbol")
247```
Hao Zhuf9aa4c42017-05-22 15:53:35 -0400248
Hao Zhu53e240f2017-09-04 20:04:29 -0400249# HTML Only Features
250## Scroll box
251If 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 -0400252
Hao Zhu53e240f2017-09-04 20:04:29 -0400253When 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 -0400254
255```{r}
Hao Zhu4840bc92017-09-15 15:55:05 -0400256kable(cbind(mtcars, mtcars), "html") %>%
Hao Zhu53e240f2017-09-04 20:04:29 -0400257 kable_styling() %>%
258 scroll_box(width = "500px", height = "200px")
Hao Zhu4c4bf8d2017-07-03 19:38:11 -0400259```