bump version...
remove magick from imports to suggests;
update documentation
update vignettes
diff --git a/vignettes/awesome_table_in_html.Rmd b/vignettes/awesome_table_in_html.Rmd
index 96baeda..e042f65 100644
--- a/vignettes/awesome_table_in_html.Rmd
+++ b/vignettes/awesome_table_in_html.Rmd
@@ -37,7 +37,7 @@
dt <- mtcars[1:5, 1:6]
```
-When 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.*
+When 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.**
```{r}
options(knitr.table.format = "html")
@@ -47,13 +47,14 @@
## Basic HTML table
Basic HTML output of `kable` looks very crude. To the end, it's just a plain HTML table without any love from css.
```{r}
-kable(dt)
+kable(dt, "html")
```
## Bootstrap theme
When 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.
```{r}
-kable(dt) %>%
+dt %>%
+ kable("html") %>%
kable_styling()
```
@@ -65,39 +66,39 @@
For example, to add striped lines (alternative row colors) to your table and you want to highlight the hovered row, you can simply type:
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling(bootstrap_options = c("striped", "hover"))
```
The 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.
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling(bootstrap_options = c("striped", "hover", "condensed"))
```
Tables 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.
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling(bootstrap_options = c("striped", "hover", "condensed", "responsive"))
```
## Full width?
By 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.)
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling(bootstrap_options = "striped", full_width = F)
```
## Position
Table 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
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling(bootstrap_options = "striped", full_width = F, position = "left")
```
Becides these three common options, you can also wrap text around the table using the `float-left` or `float-right` options.
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling(bootstrap_options = "striped", full_width = F, position = "float_right")
```
Lorem 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,13 +106,13 @@
## Font size
If 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.
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling(bootstrap_options = "striped", font_size = 7)
```
# Column / Row Specification
## Column spec
-When 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.
+When 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.
Warning: If you have a super long table, you should be cautious when you use `column_spec` as the xml node modification takes time.
@@ -125,7 +126,7 @@
)
)
-kable(text_tbl) %>%
+kable(text_tbl, "html") %>%
kable_styling(full_width = F) %>%
column_spec(1, bold = T, border_right = T) %>%
column_spec(2, width = "30em", background = "yellow")
@@ -136,24 +137,24 @@
Similar 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.
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling("striped", full_width = F) %>%
- column_spec(7, bold = T) %>%
- row_spec(5, bold = T, color = "white", background = "#D7261E")
+ column_spec(5:7, bold = T) %>%
+ row_spec(3:5, bold = T, color = "white", background = "#D7261E")
```
# Grouped Columns / Rows
## Add header rows to group columns
Tables 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)).
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling("striped") %>%
add_header_above(c(" " = 1, "Group 1" = 2, "Group 2" = 2, "Group 3" = 2))
```
In fact, if you want to add another row of header on top, please feel free to do so.
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling(c("striped", "bordered")) %>%
add_header_above(c(" ", "Group 1" = 2, "Group 2" = 2, "Group 3" = 2)) %>%
add_header_above(c(" ", "Group 4" = 4, "Group 5" = 2)) %>%
@@ -163,15 +164,23 @@
## Group rows via labeling
Sometimes 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".
```{r}
-kable(mtcars[1:10, 1:6], caption = "Group Rows") %>%
+kable(mtcars[1:10, 1:6], "html", caption = "Group Rows") %>%
kable_styling("striped", full_width = F) %>%
group_rows("Group 1", 4, 7) %>%
group_rows("Group 2", 8, 10)
```
+Another 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.
+```{r, eval = F}
+# Not evaluated. This example generates the same table as above.
+kable(mtcars[1:10, 1:6], "html", caption = "Group Rows") %>%
+ kable_styling("striped", full_width = F) %>%
+ group_rows(index = c(" " = 3, "Group 1" = 4, "Group 2" = 3))
+```
+
For advanced users, you can even define your own css for the group labeling.
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling("striped", full_width = F) %>%
group_rows("Group 1", 3, 5, label_row_css = "background-color: #666; color: #fff;")
```
@@ -180,7 +189,7 @@
Unlike `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.
For advanced users, you can even define your own css for the group labeling.
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling("striped", full_width = F) %>%
add_indent(c(1, 3, 5))
```
@@ -205,21 +214,21 @@
### Alphabet
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling("striped") %>%
add_footnote(c("Footnote 1", "Have a good day."), notation = "alphabet")
```
### Number
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling("striped") %>%
add_footnote(c("Footnote 1", "Have a good day."), notation = "number")
```
### Symbol
```{r}
-kable(dt) %>%
+kable(dt, "html") %>%
kable_styling("striped") %>%
add_footnote(c("Footnote 1", "Footnote 2", "Footnote 3"), notation = "symbol")
```
@@ -228,7 +237,7 @@
By design, `add_footnote()` will transform any `[note]` to in-table footnote markers.
```{r}
-kable(dt, caption = "Demo Table[note]") %>%
+kable(dt, "html", caption = "Demo Table[note]") %>%
kable_styling("striped") %>%
add_header_above(c(" ", "Group 1[note]" = 3, "Group 2[note]" = 3)) %>%
add_footnote(c("This table is from mtcars",
@@ -244,8 +253,7 @@
When 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.
```{r}
-kable(cbind(mtcars, mtcars)) %>%
+kable(cbind(mtcars, mtcars), "html") %>%
kable_styling() %>%
scroll_box(width = "500px", height = "200px")
```
-
diff --git a/vignettes/awesome_table_in_pdf.Rmd b/vignettes/awesome_table_in_pdf.Rmd
index e0d7e77..2d37e1b 100644
--- a/vignettes/awesome_table_in_pdf.Rmd
+++ b/vignettes/awesome_table_in_pdf.Rmd
@@ -65,7 +65,7 @@
library(kableExtra)
```
-If you are using R Sweave or some customized rmarkdown templates or you just want to load these LaTeX libraries by yourself, 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.
+If you are using R Sweave, beamer, 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.
```{yaml}
header-includes:
@@ -108,12 +108,14 @@
```
### Hold position
-If 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.
+If 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.
```{r}
kable(dt, format = "latex", caption = "Demo table", booktabs = T) %>%
kable_styling(latex_options = c("striped", "hold_position"))
```
+If 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.
+
### Scale down
When 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.
```{r}
@@ -137,10 +139,11 @@
## Full width?
-If 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. Note that, if you use `full_width` in LaTeX, you will loss your in-cell text alignment settings and everything will be left-aligned.
+If 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.
```{r}
kable(dt, format = "latex", booktabs = T) %>%
- kable_styling(full_width = T)
+ kable_styling(full_width = T) %>%
+ column_spec(1, width = "8cm")
```
## Position
@@ -192,7 +195,7 @@
kable(dt, format = "latex", booktabs = T) %>%
kable_styling("striped", full_width = F) %>%
column_spec(7, border_left = T, bold = T) %>%
- row_spec(5, bold = T, color = "white", background = "black")
+ row_spec(3:5, bold = T, color = "white", background = "black")
```
# Grouped Columns / Rows
@@ -228,6 +231,14 @@
group_rows("Group 1", 4, 5, latex_gap_space = "2em")
```
+If 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`.
+```{r, eval=FALSE}
+kable(mtcars[1:10, 1:6], format = "latex", caption = "Group Rows", booktabs = T) %>%
+ kable_styling() %>%
+ group_rows(index=c(" " = 3, "Group 1" = 4, "Group 2" = 3))
+# Not evaluated. The code above should have the same result as the first example in this section.
+```
+
## Row indentation
Unlike `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.
For advanced users, you can even define your own css for the group labeling.
@@ -237,7 +248,7 @@
```
## Group rows via multi-row cell
-Function `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.
+Function `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. If you even need to specify column/row format, use `column_spec` & `row_spec` before you pipe it into `collapse_rows`.
```{r}
collapse_rows_dt <- data.frame(C1 = c(rep("a", 10), rep("b", 5)),
@@ -306,3 +317,20 @@
group_rows("Group 1", 4, 5) %>%
landscape()
```
+
+## Use LaTeX table in HTML or Word
+If 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/).
+
+```{r, eval = F}
+# Not evaluated.
+
+# The code below will automatically include the image in the rmarkdown document
+kable(dt, "latex", booktabs = T) %>%
+ column_spec(1, bold = T) %>%
+ kable_as_image()
+
+# If you want to save the image locally, just provide a name
+kable(dt, "latex", booktabs = T) %>%
+ column_spec(1, bold = T) %>%
+ kable_as_image("my_latex_table")
+```