blob: e6032d624e1600b164d727db1a513a4cc92540f3 [file] [log] [blame]
Hao Zhu6a076462017-03-01 12:59:01 -05001---
2title: "Create Awesome LaTeX Table with knitr::kable and kableExtra"
3author: "Hao Zhu"
4date: "`r Sys.Date()`"
5output:
6 pdf_document:
7 toc: true
8 toc_depth: 2
Hao Zhu014d6212017-08-07 04:20:23 +08009header-includes:
10 - \usepackage{booktabs}
11 - \usepackage{longtable}
12 - \usepackage{array}
13 - \usepackage{multirow}
14 - \usepackage[table]{xcolor}
15 - \usepackage{wrapfig}
Hao Zhu245931c2017-09-01 22:43:56 -040016 - \usepackage{float}
Hao Zhu65216052017-09-04 13:01:29 -040017 - \usepackage{colortbl}
18 - \usepackage{pdflscape}
19 - \usepackage{tabu}
20 - \usepackage{threeparttable}
Hao Zhuef0c8302018-01-12 13:30:20 -050021 - \usepackage[normalem]{ulem}
Hao Zhu014d6212017-08-07 04:20:23 +080022vignette: >
23 %\VignetteIndexEntry{Create Awesome PDF Table with knitr::kable and kableExtra}
24 %\VignetteEngine{knitr::rmarkdown}
25 %\VignetteEncoding{UTF-8}
Hao Zhu6a076462017-03-01 12:59:01 -050026---
27
Hao Zhu6a1cbb52017-10-24 15:54:50 -040028\clearpage
29
Hao Zhue1be9602017-08-17 15:44:31 -040030> Please see the package [documentation site](http://haozhu233.github.io/kableExtra) for how to use this package in HTML and more.
Hao Zhu014d6212017-08-07 04:20:23 +080031
Hao Zhu6a076462017-03-01 12:59:01 -050032# Overview
33The 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`.
34
Hao Zhu0a0e8332017-08-03 13:21:29 -040035To learn how to generate complex tables in LaTeX, please visit [http://haozhu233.github.io/kableExtra/awesome_table_in_html.html](http://haozhu233.github.io/kableExtra/awesome_table_in_html.html).
36
Hao Zhu6a076462017-03-01 12:59:01 -050037# Installation
Hao Zhu6a076462017-03-01 12:59:01 -050038```r
Hao Zhu74eb6ad2017-03-04 09:32:37 -050039install.packages("kableExtra")
40
Hao Zhu6a076462017-03-01 12:59:01 -050041# For dev version
Hao Zhuf9aa4c42017-05-22 15:53:35 -040042# install.packages("devtools")
Hao Zhu6a076462017-03-01 12:59:01 -050043devtools::install_github("haozhu233/kableExtra")
44```
Hao Zhuf9aa4c42017-05-22 15:53:35 -040045
Hao Zhu6a076462017-03-01 12:59:01 -050046# Getting Started
47Here we are using the first few columns and rows from dataset `mtcars`
48```{r}
49library(knitr)
50library(kableExtra)
51dt <- mtcars[1:5, 1:6]
52```
53
Hao Zhu65216052017-09-04 13:01:29 -040054When 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 = "latex")` so you don't repeat the step everytime.* **In this tutorial, I'll still put `format="latex"` in the function in case users just want to quickly replicate the results.**
Hao Zhu6a076462017-03-01 12:59:01 -050055
56```{r}
57options(knitr.table.format = "latex")
58## If you don't define format here, you'll need put `format = "latex"`
59## in every kable function.
60```
61
Hao Zhuc761ee52017-09-04 13:04:35 -040062## LaTeX packages used in this package
Hao Zhu65216052017-09-04 13:01:29 -040063If you are using a recent version of rmarkdown, you are recommended to load this package entirely via `library(kableExtra)` or `require(kableExtra)` because this package will load all necessary LaTeX packages, such as `booktabs` or `multirow`, for you automatically. Note that, if you are calling functions from `kableExtra` via `kableExtra::kable_styling()` or if you put `library(kableExtra)` in a separate R file that is **sourced** by the rmarkdown document, these packages won't be loaded. Furthermore, you can suppress this auto-loading behavior by setting a global option `kableExtra.latex.load_packages` to be `FALSE` before you load `kableExtra`.
64
Hao Zhub350b9f2017-09-04 13:07:57 -040065```{r, eval = FALSE}
Hao Zhu2e318eb2017-09-04 13:18:42 -040066# Not evaluated. Ilustration purpose
Hao Zhu5ece06e2018-01-19 23:18:02 -050067options(kableExtra.latex.load_packages = FALSE)
Hao Zhu2e318eb2017-09-04 13:18:42 -040068library(kableExtra)
Hao Zhu65216052017-09-04 13:01:29 -040069```
70
Hao Zhuce5ee412017-10-23 01:14:38 -040071If you are using R Sweave, beamer, R package vignette template, tufte or some customized rmarkdown templates, you can put the following meta data into the `yaml` section. If you are familar with LaTeX and you know what you are doing, feel free to remove unnecessary packages from the list.
Hao Zhu65216052017-09-04 13:01:29 -040072
Hao Zhuce5ee412017-10-23 01:14:38 -040073```
Hao Zhu65216052017-09-04 13:01:29 -040074header-includes:
75 - \usepackage{booktabs}
76 - \usepackage{longtable}
77 - \usepackage{array}
78 - \usepackage{multirow}
79 - \usepackage[table]{xcolor}
80 - \usepackage{wrapfig}
81 - \usepackage{float}
82 - \usepackage{colortbl}
83 - \usepackage{pdflscape}
84 - \usepackage{tabu}
85 - \usepackage{threeparttable}
Hao Zhuef0c8302018-01-12 13:30:20 -050086 - \usepackage[normalem]{ulem}
Hao Zhu65216052017-09-04 13:01:29 -040087```
88
Hao Zhu6a076462017-03-01 12:59:01 -050089## Plain LaTeX
90Plain LaTeX table looks relatively ugly in 2017.
91```{r}
Hao Zhu6a1cbb52017-10-24 15:54:50 -040092# As I said, you don't need format = "latex" if you have defined
93# knitr.table.format in options.
94kable(dt, format = "latex")
Hao Zhu6a076462017-03-01 12:59:01 -050095```
96
Hao Zhu0a0e8332017-08-03 13:21:29 -040097## LaTeX table with booktabs
Hao Zhu6a076462017-03-01 12:59:01 -050098Similar with Bootstrap in HTML, in LaTeX, you can also use a trick to make your table look prettier as well. The different part is that, this time you don't need to pipe kable outputs to another function. Instead, you should call `booktabs = T` directly in `kable()`
99```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400100kable(dt, format = "latex", booktabs = T)
Hao Zhu6a076462017-03-01 12:59:01 -0500101```
102
103# Table Styles
104`kable_styling` in LaTeX uses the same syntax and structure as `kable_styling` in HTML. However, instead of `bootstrap_options`, you should specify `latex_options` instead.
105
Hao Zhu0a0e8332017-08-03 13:21:29 -0400106## LaTeX options
Hao Zhu6a076462017-03-01 12:59:01 -0500107Similar with `bootstap_options`, `latex_options` is also a charter vector with a bunch of options including `striped`, `hold_position` and `scale_down`.
108
109### Striped
110Even though in the LaTeX world, people usually call it `alternative row colors` but here I'm using its bootstrap name for consistency. Note that to make it happen, LaTeX package `xcolor` is required to be loaded. In an environment like rmarkdown::pdf_document (rmarkdown 1.4.0 +), `kable_styling` will load it automatically if `striped` is enabled. However, in other cases, you probably need to import that package by yourself.
111```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400112kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500113 kable_styling(latex_options = "striped")
114```
115
Hao Zhu0a0e8332017-08-03 13:21:29 -0400116### Hold position
Hao Zhuf03decd2017-09-13 10:45:44 -0400117If you provide a table caption in `kable()`, it will put your LaTeX tabular in a `table` environment, unless you are using `longtable`. A `table` environment will automatically find the best place (it thinks) to put your table. However, in many cases, you do want your table to appear in a position you want it to be. In this case, you can use this `hold_position` options here.
Hao Zhu6a076462017-03-01 12:59:01 -0500118```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400119kable(dt, format = "latex", caption = "Demo table", booktabs = T) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500120 kable_styling(latex_options = c("striped", "hold_position"))
121```
122
Hao Zhuf03decd2017-09-13 10:45:44 -0400123If you find `hold_position` is not powerful enough to literally PIN your table in the exact position, you may want to use `HOLD_position`, which is a more powerful version of this feature. For those who are familar with LaTeX, `hold_position` uses `[!h]` and `HOLD_position` uses `[H]` and the `float` package.
124
Hao Zhu6a076462017-03-01 12:59:01 -0500125### Scale down
Hao Zhuf9aa4c42017-05-22 15:53:35 -0400126When you have a wide table that will normally go out of the page and you want to scale down the table to fit the page, you can use the `scale_down` option here. Note that, if your table is too small, it will also scale up your table. It was named in this way only because scaling up isn't very useful in most cases.
Hao Zhu6a076462017-03-01 12:59:01 -0500127```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400128kable(cbind(dt, dt, dt), format = "latex", booktabs = T) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500129 kable_styling(latex_options = c("striped", "scale_down"))
130```
131```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400132kable(cbind(dt), format = "latex", booktabs = T) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500133 kable_styling(latex_options = c("striped", "scale_down"))
134```
135
Hao Zhu0a0e8332017-08-03 13:21:29 -0400136### Repeat header in longtable
137In `kableExtra` 0.3.0 or above, a new option `repeat_header` was introduced into `kable_styling`. It will add header rows to longtables spanning multiple pages. For table captions on following pages, it will append *"continued"* to the caption to differentiate. If you need texts other than *"(continued)"* (for example, other languages), you can specify it using `kable_styling(..., repeat_header_text = "xxx")`. If you want to complete replace the table caption instead of appending, you can specify it in the option `repeat_header_method`.
Hao Zhu6ff9d502017-06-13 17:13:03 -0400138```{r}
139long_dt <- rbind(mtcars, mtcars)
140
Hao Zhu65216052017-09-04 13:01:29 -0400141kable(long_dt, format = "latex", longtable = T, booktabs = T, caption = "Longtable") %>%
Hao Zhu6ff9d502017-06-13 17:13:03 -0400142 add_header_above(c(" ", "Group 1" = 5, "Group 2" = 6)) %>%
143 kable_styling(latex_options = c("repeat_header"))
144```
145
Hao Zhu6a076462017-03-01 12:59:01 -0500146
Hao Zhu0a0e8332017-08-03 13:21:29 -0400147## Full width?
Hao Zhuf03decd2017-09-13 10:45:44 -0400148If you have a small table and you want it to spread wide on the page, you can try the `full_width` option. Unlike `scale_down`, it won't change your font size. You can use `column_spec`, which will be explained later, together with `full_width` to achieve the best result.
Hao Zhu6a076462017-03-01 12:59:01 -0500149```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400150kable(dt, format = "latex", booktabs = T) %>%
Hao Zhuf03decd2017-09-13 10:45:44 -0400151 kable_styling(full_width = T) %>%
152 column_spec(1, width = "8cm")
Hao Zhu6a076462017-03-01 12:59:01 -0500153```
154
155## Position
156Table Position only matters when the table doesn't have `full_width`. You can choose to align the table to `center` or `left` side of the page. The default value of position is `center`.
157
158Note that even though you can select to `right` align your table but the table will actually be centered. Somehow it is very difficult to right align a table in LaTeX (since it's not very useful in the real world?). If you know how to do it, please send out an issue or PR and let me know.
159```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400160kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500161 kable_styling(position = "center")
162```
163
164Becides these three common options, you can also wrap text around the table using the `float-left` or `float-right` options. Note that, like `striped`, this feature will load another non-default LaTeX package `wrapfig` which requires rmarkdown 1.4.0 +. If you rmarkdown version < 1.4.0, you need to load the package through a customed LaTeX template file.
165```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400166kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500167 kable_styling(position = "float_right")
168```
169Lorem 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.
170
171## Font Size
172If 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.
173```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400174kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500175 kable_styling(font_size = 7)
176```
177
Hao Zhu0a0e8332017-08-03 13:21:29 -0400178# Column / Row Specification
179## Column spec
180When 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.
181```{r}
182text_tbl <- data.frame(
183 Items = c("Item 1", "Item 2", "Item 3"),
184 Features = c(
185 "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vehicula tempor ex. Morbi malesuada sagittis turpis, at venenatis nisl luctus a. ",
186 "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. ",
187 "Vivamus venenatis egestas eros ut tempus. Vivamus id est nisi. Aliquam molestie erat et sollicitudin venenatis. In ac lacus at velit scelerisque mattis. "
188 )
189)
190
Hao Zhu65216052017-09-04 13:01:29 -0400191kable(text_tbl, format = "latex", booktabs = T) %>%
Hao Zhu0a0e8332017-08-03 13:21:29 -0400192 kable_styling(full_width = F) %>%
Hao Zhua44e3752017-09-05 12:56:19 -0400193 column_spec(1, bold = T, color = "red") %>%
Hao Zhu0a0e8332017-08-03 13:21:29 -0400194 column_spec(2, width = "30em")
195```
196
197## Row spec
198Similar 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.
199
200```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400201kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu0a0e8332017-08-03 13:21:29 -0400202 kable_styling("striped", full_width = F) %>%
Hao Zhuf70fba92017-09-07 17:53:40 -0400203 column_spec(7, border_left = T, bold = T) %>%
Hao Zhuef0c8302018-01-12 13:30:20 -0500204 row_spec(1, strikeout = T) %>%
Hao Zhuf03decd2017-09-13 10:45:44 -0400205 row_spec(3:5, bold = T, color = "white", background = "black")
Hao Zhu0a0e8332017-08-03 13:21:29 -0400206```
207
Hao Zhu6f362bb2017-10-23 23:21:38 -0400208## Header Rows
209One special case of `row_spec` is that you can specify the format of the header row via `row_spec(row = 0, ...)`.
210```{r}
211kable(dt, format = "latex", booktabs = T, align = "c") %>%
212 kable_styling(latex_options = "striped", full_width = F) %>%
213 row_spec(0, angle = 45)
214```
215
216
217
Hao Zhuce5ee412017-10-23 01:14:38 -0400218# Cell/Text Specification
219Function `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:
220* 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
221* `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.
222
223Currently, `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.
224
225## Conditional logic
226It is very easy to use `cell_spec` with conditional logic. Here is an example.
Hao Zhu6f362bb2017-10-23 23:21:38 -0400227```{r, message=FALSE, warning=FALSE}
228library(dplyr)
Hao Zhuce5ee412017-10-23 01:14:38 -0400229mtcars[1:10, 1:2] %>%
230 mutate(
Hao Zhuce5ee412017-10-23 01:14:38 -0400231 car = row.names(.),
Hao Zhu6f362bb2017-10-23 23:21:38 -0400232 # You don't need format = "latex" if you have ever defined options(knitr.table.format)
233 mpg = cell_spec(mpg, "latex", color = ifelse(mpg > 20, "red", "blue")),
234 cyl = cell_spec(cyl, "latex", color = "white", align = "c", angle = 45,
Hao Zhuce5ee412017-10-23 01:14:38 -0400235 background = factor(cyl, c(4, 6, 8),
236 c("#666666", "#999999", "#BBBBBB")))
237 ) %>%
238 select(car, mpg, cyl) %>%
239 kable("latex", escape = F, booktabs = T, linesep = "")
240```
241
242## Visualize data with Viridis Color
Hao Zhu07305132017-10-24 15:41:49 -0400243This 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 Zhuce5ee412017-10-23 01:14:38 -0400244
245```{r}
246iris[1:10, ] %>%
247 mutate_if(is.numeric, function(x) {
Hao Zhu6f362bb2017-10-23 23:21:38 -0400248 cell_spec(x, "latex", bold = T, color = spec_color(x, end = 0.9),
Hao Zhuce5ee412017-10-23 01:14:38 -0400249 font_size = spec_font_size(x))
250 }) %>%
251 mutate(Species = cell_spec(
Hao Zhu6f362bb2017-10-23 23:21:38 -0400252 Species, "latex", color = "white", bold = T,
Hao Zhuce5ee412017-10-23 01:14:38 -0400253 background = spec_color(1:10, end = 0.9, option = "A", direction = -1)
254 )) %>%
255 kable("latex", escape = F, booktabs = T, linesep = "", align = "c")
256```
257
258In 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.
259
260## Text Specification
261If 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.
262
Hao Zhu6f362bb2017-10-23 23:21:38 -0400263An aliased function `text_spec` is also provided for a more literal writing experience. The only difference is that in LaTeX, unless you specify `latex_background_in_cell = FALSE` (default is `TRUE`) in `cell_spec`, it will define cell background color as `\cellcolor{}`, which doesn't work outside of a table, while for `text_spec`, the default value for `latex_background_in_cell` is `FALSE`.
Hao Zhuce5ee412017-10-23 01:14:38 -0400264
265```{r}
266sometext <- strsplit(paste0(
Hao Zhu6290fdd2017-10-24 00:10:32 -0400267 "You can even try to make some crazy things like this paragraph. ",
Hao Zhu6a1cbb52017-10-24 15:54:50 -0400268 "It may seem like a useless feature right now but it's so cool ",
269 "and nobody can resist. ;)"
Hao Zhuce5ee412017-10-23 01:14:38 -0400270), " ")[[1]]
271text_formatted <- paste(
Hao Zhu6f362bb2017-10-23 23:21:38 -0400272 text_spec(sometext, "latex", color = spec_color(1:length(sometext), end = 0.9),
273 font_size = spec_font_size(1:length(sometext), begin = 5, end = 20)),
Hao Zhuce5ee412017-10-23 01:14:38 -0400274 collapse = " ")
275
276# To display the text, type `r text_formatted` outside of the chunk
277```
278`r text_formatted`
279
Hao Zhu0a0e8332017-08-03 13:21:29 -0400280# Grouped Columns / Rows
281## Add header rows to group columns
Hao Zhu6a076462017-03-01 12:59:01 -0500282Tables 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)).
283```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400284kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500285 kable_styling() %>%
286 add_header_above(c(" " = 1, "Group 1" = 2, "Group 2" = 2, "Group 3" = 2))
287```
288
Hao Zhuce5ee412017-10-23 01:14:38 -0400289In fact, if you want to add another row of header on top, please feel free to do so. Also, since kableExtra 0.3.0, you can specify `bold` & `italic` as you do in `row_spec()`.
Hao Zhu6a076462017-03-01 12:59:01 -0500290```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400291kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu00ba87c2017-08-01 12:42:58 -0400292 kable_styling(latex_options = "striped") %>%
Hao Zhu6a076462017-03-01 12:59:01 -0500293 add_header_above(c(" ", "Group 1" = 2, "Group 2" = 2, "Group 3" = 2)) %>%
294 add_header_above(c(" ", "Group 4" = 4, "Group 5" = 2)) %>%
Hao Zhu916c3662017-06-21 15:55:05 -0400295 add_header_above(c(" ", "Group 6" = 6), bold = T, italic = T)
Hao Zhu6a076462017-03-01 12:59:01 -0500296```
297
Hao Zhu0a0e8332017-08-03 13:21:29 -0400298## Group rows via labeling
299Sometimes 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".
300```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400301kable(mtcars[1:10, 1:6], format = "latex", caption = "Group Rows", booktabs = T) %>%
Hao Zhu0a0e8332017-08-03 13:21:29 -0400302 kable_styling() %>%
303 group_rows("Group 1", 4, 7) %>%
304 group_rows("Group 2", 8, 10)
305```
306
307In case some users need it, you can define your own gapping spaces between the group labeling row and previous rows. The default value is `0.5em`.
308```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400309kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu0a0e8332017-08-03 13:21:29 -0400310 group_rows("Group 1", 4, 5, latex_gap_space = "2em")
311```
312
Hao Zhuf03decd2017-09-13 10:45:44 -0400313If you prefer to build multiple groups in one step, you can use the short-hand `index` option. Basically, you can use it in the same way as you use `add_header_above`. However, since `group_row` only support one layer of grouping, you can't add multiple layers of grouping header as you can do in `add_header_above`.
314```{r, eval=FALSE}
315kable(mtcars[1:10, 1:6], format = "latex", caption = "Group Rows", booktabs = T) %>%
316 kable_styling() %>%
317 group_rows(index=c(" " = 3, "Group 1" = 4, "Group 2" = 3))
318# Not evaluated. The code above should have the same result as the first example in this section.
319```
320
Hao Zhu23bde3a2018-03-28 16:00:55 -0400321Note that `kable` has a relatively special feature to handle `align` and it may bring troubles to you if you are not using it correctly. In the documentation of the `align` argument of `kable`, it says:
322
323> If `length(align) == 1L`, the string will be expanded to a vector of individual letters, e.g. `'clc'` becomes `c('c', 'l', 'c')`, **unless the output format is LaTeX**.
324
325For example,
326```{r, eval=F}
327kable(mtcars[1:2, 1:2], "latex", align = c("cl"))
328# \begin{tabular}{l|cl|cl} # Note the column alignment here
329# \hline
330# & mpg & cyl\\
331# ...
332```
333
334LaTeX, somehow shows surprisingly high tolerance on that, which is quite unusual. As a result, it won't throw an error if you are just using `kable` to make some simple tables. However, when you use `kableExtra` to make some advanced modification, it will start to throw some bugs. As a result, please try to form a habbit of using a vector in the `align` argument for `kable` (tip: you can use `rep` function to replicate elements. For example, `c("c", rep("l", 10))`).
335
Hao Zhu0a0e8332017-08-03 13:21:29 -0400336## Row indentation
337Unlike `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.
338For advanced users, you can even define your own css for the group labeling.
339```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400340kable(dt, format = "latex", booktabs = T) %>%
Hao Zhu0a0e8332017-08-03 13:21:29 -0400341 add_indent(c(1, 3, 5))
342```
343
344## Group rows via multi-row cell
Hao Zhu12b0ade2018-01-13 16:19:58 -0500345Function `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.
346
347In LaTeX, `collapse_rows` adds some extra hlines to help differentiate groups. You can customize this behavior using the `latex_hline` argument. You can choose from `full` (default), `major` and `none`.
Hao Zhu0a0e8332017-08-03 13:21:29 -0400348
349```{r}
350collapse_rows_dt <- data.frame(C1 = c(rep("a", 10), rep("b", 5)),
351 C2 = c(rep("c", 7), rep("d", 3), rep("c", 2), rep("d", 3)),
352 C3 = 1:15,
353 C4 = sample(c(0,1), 15, replace = TRUE))
Hao Zhu65216052017-09-04 13:01:29 -0400354kable(collapse_rows_dt, format = "latex", booktabs = T, align = "c") %>%
Hao Zhu0a0e8332017-08-03 13:21:29 -0400355 column_spec(1, bold=T) %>%
Hao Zhu12b0ade2018-01-13 16:19:58 -0500356 collapse_rows(columns = 1:2, latex_hline = "major")
Hao Zhu0a0e8332017-08-03 13:21:29 -0400357```
358
359```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400360kable(collapse_rows_dt, format = "latex", align = "c") %>%
Hao Zhu0a0e8332017-08-03 13:21:29 -0400361 column_spec(1, bold = T, width = "5em") %>%
362 collapse_rows(1:2)
363```
364
Hao Zhu778b70a2018-04-02 12:21:17 -0400365When there are too many layers, sometimes the table can become too wide. You can choose to stack the first few layers by setting `row_group_label_position` to `stack`.
Hao Zhu23bde3a2018-03-28 16:00:55 -0400366
367
Hao Zhu778b70a2018-04-02 12:21:17 -0400368```{r}
369collapse_rows_dt <- expand.grid(
370 Country = sprintf('Country with a long name %s', c('A', 'B')),
371 State = sprintf('State %s', c('a', 'b')),
372 City = sprintf('City %s', c('1', '2')),
373 District = sprintf('District %s', c('1', '2'))
374) %>% arrange(Country, State, City) %>%
375 mutate_all(as.character) %>%
376 mutate(C1 = rnorm(n()),
377 C2 = rnorm(n()))
378
379kable(collapse_rows_dt, format = "latex",
380 booktabs = T, align = "c", linesep = '') %>%
381 collapse_rows(1:3, row_group_label_position = 'stack')
382```
383
384To better distinguish different layers, you can format the each layer using `row_group_label_fonts`. You can also customize the hlines to better differentiate groups.
385
386```{r}
387row_group_label_fonts <- list(
388 list(bold = T, italic = T),
389 list(bold = F, italic = F)
390 )
391kable(collapse_rows_dt, format = "latex",
392 booktabs = T, align = "c", linesep = '') %>%
393 column_spec(1, bold=T) %>%
394 collapse_rows(1:3, latex_hline = 'custom', custom_latex_hline = 1:3,
395 row_group_label_position = 'stack',
396 row_group_label_fonts = row_group_label_fonts)
397```
398
Hao Zhu0a0e8332017-08-03 13:21:29 -0400399# Table Footnote
Hao Zhu6a076462017-03-01 12:59:01 -0500400
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500401> Now it's recommended to use the new `footnote` function instead of `add_footnote` to make table footnotes.
402
403Documentations for `add_footnote` can be found [here](http://haozhu233.github.io/kableExtra/legacy_features#add_footnote).
404
405There 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 -0500406```{r}
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500407kable(dt, "latex", align = "c") %>%
408 kable_styling(full_width = F) %>%
409 footnote(general = "Here is a general comments of the table. ",
410 number = c("Footnote 1; ", "Footnote 2; "),
411 alphabet = c("Footnote A; ", "Footnote B; "),
412 symbol = c("Footnote Symbol 1; ", "Footnote Symbol 2")
413 )
Hao Zhu6a076462017-03-01 12:59:01 -0500414```
415
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500416You 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`.
417
Hao Zhu6a076462017-03-01 12:59:01 -0500418```{r}
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500419kable(dt, "latex", align = "c", booktabs = T) %>%
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: ",
426 footnote_as_chunk = T
427 )
Hao Zhu6a076462017-03-01 12:59:01 -0500428```
429
Hao Zhu4f8eaa22018-01-11 16:14:25 -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 Zhu6a076462017-03-01 12:59:01 -0500431
Hao Zhu6a076462017-03-01 12:59:01 -0500432```{r}
Hao Zhu4f8eaa22018-01-11 16:14:25 -0500433dt_footnote <- dt
434names(dt_footnote)[2] <- paste0(names(dt_footnote)[2],
435 # That "latex" can be eliminated if defined in global
436 footnote_marker_symbol(1, "latex"))
437row.names(dt_footnote)[4] <- paste0(row.names(dt_footnote)[4],
438 footnote_marker_alphabet(1))
439kable(dt_footnote, "latex", align = "c", booktabs = T,
440 # Remember this escape = F
441 escape = 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 Zhu23bde3a2018-03-28 16:00:55 -0400448If your table footnote is very long, please consider to put your table in a `ThreePartTable` frame. Note that, in kableExtra version <= 0.7.0, we were using `threeparttable` but since kableExtra 0.8.0, we start to use `ThreePartTable` from `threeparttablex` instead. `ThreePartTable` supports both the `longtable` and `tabu` environments.
449
450```{r}
451kable(dt, "latex", align = "c", booktabs = T, caption = "s") %>%
452 footnote(general = "Here is a very very very very very very very very very very very very very very very very very very very very long footnote",
453 threeparttable = T)
454```
455
Hao Zhu0a0e8332017-08-03 13:21:29 -0400456# LaTeX Only Features
457## Table on a Landscape Page
Hao Zhu4278c632017-05-24 01:02:50 -0400458Sometimes when we have a wide table, we want it to sit on a designated landscape page. The new function `landscape()` can help you on that. Unlike other functions, this little function only serves LaTeX and doesn't have a HTML side.
459```{r}
Hao Zhu65216052017-09-04 13:01:29 -0400460kable(dt, format = "latex", caption = "Demo Table (Landscape)[note]", booktabs = T) %>%
Hao Zhu4278c632017-05-24 01:02:50 -0400461 kable_styling(latex_options = c("hold_position")) %>%
462 add_header_above(c(" ", "Group 1[note]" = 3, "Group 2[note]" = 3)) %>%
463 add_footnote(c("This table is from mtcars",
464 "Group 1 contains mpg, cyl and disp",
465 "Group 2 contains hp, drat and wt"),
466 notation = "symbol") %>%
467 group_rows("Group 1", 4, 5) %>%
468 landscape()
469```
Hao Zhu4840bc92017-09-15 15:55:05 -0400470
471## Use LaTeX table in HTML or Word
472If you want to include a LaTeX rendered table in your HTML or Word document, or if you just want to save table as an image, you may consider to use `kable_as_image()`. Note that this feature requires you to have [magick](https://github.com/ropensci/magick) installed (`install.packages("magick")`). Also, if you are planning to use it on Windows, you need to install [Ghostscript](https://www.ghostscript.com/).
473
474```{r, eval = F}
475# Not evaluated.
476
477# The code below will automatically include the image in the rmarkdown document
478kable(dt, "latex", booktabs = T) %>%
479 column_spec(1, bold = T) %>%
480 kable_as_image()
481
482# If you want to save the image locally, just provide a name
483kable(dt, "latex", booktabs = T) %>%
484 column_spec(1, bold = T) %>%
485 kable_as_image("my_latex_table")
486```