blob: 1ae13845038f70eb18ec4141feb3706936a4eb0f [file] [log] [blame]
Hao Zhu8902df82019-01-07 16:27:32 -05001---
2title: "Save Tables and Use them as Images"
3author: "Hao"
4date: "1/7/2019"
5output: html_document
6---
7
8Before `kableExtra` 1.0, we have a function called `kable_as_image`, which can transform a LaTeX tables to an image and include it in an rmarkdown document. Starting from `kableExtra` 1.0, we will split this function into two pieces: `save_kable` and `as_image`. `save_kable` will save any LaTeX and **HTML** tables to any format (`html`, `png`, `jpg`, `pdf` etc.). The output format will be defined by the file extension of the output file name. Here are a few examples.
9
10```{r, eval=FALSE}
11# not evaluating
12library(kableExtra)
13
14kable(mtcars[1:5, ], "html") %>%
15 kable_styling("striped") %>%
16 row_spec(1, color = "red") %>%
17 save_kable("inst/test.pdf")
18
19kable(mtcars, "latex") %>%
20 kable_styling(latex_options = "striped") %>%
21 save_kable("inst/test.png")
22```
23
Hao Zhu23ddaf32019-01-08 13:42:26 -050024# Turn your tables into images for cross-formating support
25`kableExtra` only supports `HTML` and `LaTeX`. One way to get it work with `Word` is to render the table `as_image`. This example below shows you how to render a LaTeX table in HTML document. Same rules applies when you use them in `rmarkdown::word_document`.
26
Hao Zhu8902df82019-01-07 16:27:32 -050027```{r}
28library(kableExtra)
29
30kable(mtcars, "latex", booktabs = T) %>%
31 kable_styling(latex_options = c("striped", "scale_down")) %>%
32 row_spec(1, color = "red") %>%
33 as_image()
34```
35
Hao Zhu7c39cba2019-01-08 15:29:33 -050036You can also specify either `width` or `height` of the image. The image will be scaled properly. The units are in inches.
Hao Zhu8902df82019-01-07 16:27:32 -050037
38```{r}
39kable(mtcars, "latex", booktabs = T) %>%
40 kable_styling(latex_options = c("striped", "scale_down")) %>%
41 row_spec(1, color = "red") %>%
42 as_image(width = 8)
43```
44
Hao Zhu7c39cba2019-01-08 15:29:33 -050045`as_image` also works for HTML tables. It means that you can also put in a bootstrap flavored table (image) in Word or PDF.
Hao Zhu8902df82019-01-07 16:27:32 -050046```{r}
47kable(mtcars, "html") %>%
48 kable_styling("striped") %>%
49 row_spec(1, color = "red") %>%
Hao Zhu7c39cba2019-01-08 15:29:33 -050050 as_image(width = 4)
Hao Zhu8902df82019-01-07 16:27:32 -050051```
52
Hao Zhu7c39cba2019-01-08 15:29:33 -050053One problem with this method, especially if you are using it in `Word`, is that to the end, the product you made is a picture. Please let your readers know that they cannot select/edit the tables. :P