library(tinytable)
@@ -357,9 +360,9 @@ Tiny Tables
- tinytable_y8u50qp44b9nzxjjjp2t
+ tinytable_bg123fjsemjj3zc08n46
@@ -377,7 +380,7 @@ Tiny Tables
-
+
@@ -423,12 +426,12 @@ Tiny Tables
@@ -448,96 +451,20 @@ Tiny Tables
-
-Output formats
-tinytable can produce tables in HTML, Word, Markdown, LaTeX, PDF, or PNG format. An appropriate output format for printing is automatically selected based on (1) whether the function is called interactively, (2) is called within RStudio, and (3) the output format of the Rmarkdown or Quarto document, if applicable. Alternatively, users can specify the print format in print() or by setting a global option:
-
-tt(x) |> print("markdown")
-tt(x) |> print("html")
-tt(x) |> print("latex")
-
-options(tinytable_print_output = "markdown")
-
-With the save_tt() function, users can also save tables directly to PNG (images), PDF or Word documents, and to any of the basic formats. All we need to do is supply a valid file name with the appropriate extension (ex: .png, .html, .pdf, etc.):
-tt(x) |> save_tt("path/to/file.png")
-tt(x) |> save_tt("path/to/file.pdf")
-tt(x) |> save_tt("path/to/file.docx")
-tt(x) |> save_tt("path/to/file.html")
-tt(x) |> save_tt("path/to/file.tex")
-tt(x) |> save_tt("path/to/file.md")
-save_tt() can also return a string with the table in it, for further processing in R. In the first case, the table is printed to console with cat(). In the second case, it returns as a single string as an R object.
-
-tt(mtcars[1:10, 1:5]) |>
- group_tt(
- i = list(
- "Hello" = 3,
- "World" = 8),
- j = list(
- "Foo" = 2:3,
- "Bar" = 4:5)) |>
- print("markdown")
-
-
-+------+-------------+------------+
-| | Foo | Bar |
-+------+-----+-------+-----+------+
-| mpg | cyl | disp | hp | drat |
-+======+=====+=======+=====+======+
-| 21 | 6 | 160 | 110 | 3.9 |
-+------+-----+-------+-----+------+
-| 21 | 6 | 160 | 110 | 3.9 |
-+------+-----+-------+-----+------+
-| Hello |
-+------+-----+-------+-----+------+
-| 22.8 | 4 | 108 | 93 | 3.85 |
-+------+-----+-------+-----+------+
-| 21.4 | 6 | 258 | 110 | 3.08 |
-+------+-----+-------+-----+------+
-| 18.7 | 8 | 360 | 175 | 3.15 |
-+------+-----+-------+-----+------+
-| 18.1 | 6 | 225 | 105 | 2.76 |
-+------+-----+-------+-----+------+
-| 14.3 | 8 | 360 | 245 | 3.21 |
-+------+-----+-------+-----+------+
-| World |
-+------+-----+-------+-----+------+
-| 24.4 | 4 | 146.7 | 62 | 3.69 |
-+------+-----+-------+-----+------+
-| 22.8 | 4 | 140.8 | 95 | 3.92 |
-+------+-----+-------+-----+------+
-| 19.2 | 6 | 167.6 | 123 | 3.92 |
-+------+-----+-------+-----+------+
-
-
-
-tt(mtcars[1:10, 1:5]) |>
- group_tt(
- i = list(
- "Hello" = 3,
- "World" = 8),
- j = list(
- "Foo" = 2:3,
- "Bar" = 4:5)) |>
- save_tt("markdown")
-
-[1] "+------+-------------+------------+\n| | Foo | Bar |\n+------+-----+-------+-----+------+\n| mpg | cyl | disp | hp | drat |\n+======+=====+=======+=====+======+\n| 21 | 6 | 160 | 110 | 3.9 |\n+------+-----+-------+-----+------+\n| 21 | 6 | 160 | 110 | 3.9 |\n+------+-----+-------+-----+------+\n| Hello |\n+------+-----+-------+-----+------+\n| 22.8 | 4 | 108 | 93 | 3.85 |\n+------+-----+-------+-----+------+\n| 21.4 | 6 | 258 | 110 | 3.08 |\n+------+-----+-------+-----+------+\n| 18.7 | 8 | 360 | 175 | 3.15 |\n+------+-----+-------+-----+------+\n| 18.1 | 6 | 225 | 105 | 2.76 |\n+------+-----+-------+-----+------+\n| 14.3 | 8 | 360 | 245 | 3.21 |\n+------+-----+-------+-----+------+\n| World |\n+------+-----+-------+-----+------+\n| 24.4 | 4 | 146.7 | 62 | 3.69 |\n+------+-----+-------+-----+------+\n| 22.8 | 4 | 140.8 | 95 | 3.92 |\n+------+-----+-------+-----+------+\n| 19.2 | 6 | 167.6 | 123 | 3.92 |\n+------+-----+-------+-----+------+"
-
-
-
Themes
tinytable offers a few basic themes out of the box: “default”, “striped”, “bootstrap”, “grid”, “void.” Those themes can be applied with the theme argument of the tt() function. As we will see below, it is easy to go much beyond those basic settings to customize your own tables. Here we only illustrate a few of the simplest settings:
-tt(x, theme = "striped")
+tt(x, theme = "striped")
- tinytable_hiyjjqe1qlv1wiigdg1z
+ tinytable_l8f2wk1bq373aeanv9om
@@ -555,7 +482,7 @@ Themes
-
+
@@ -601,12 +528,12 @@ Themes
@@ -642,16 +569,16 @@ Themes
-tt(x, theme = "grid")
+tt(x, theme = "grid")
- tinytable_t1fy4gtin8vn5egilf3d
+ tinytable_6rn9mctzlzwkhd1olybm
@@ -669,7 +596,7 @@ Themes
-
+
@@ -715,12 +642,12 @@ Themes
@@ -756,16 +683,16 @@ Themes
-tt(x, theme = "bootstrap")
+tt(x, theme = "bootstrap")
- tinytable_mgkzn9vb0arh7vr0uit7
+ tinytable_rmixurrdryvbj7shytwb
@@ -783,7 +710,7 @@ Themes
-
+
@@ -829,12 +756,12 @@ Themes
@@ -870,26 +797,20 @@ Themes
-
-Alignment
-To align columns, we use a single character, or a string where each letter represents a column:
+
+Width
+The width arguments accepts a number between 0 and 1, indicating what proportion of the linewidth the table should cover:
-dat <- data.frame(
- a = c("a", "aa", "aaa"),
- b = c("b", "bb", "bbb"),
- c = c("c", "cc", "ccc"))
-
-tt(dat) |> style_tt(j = 1:3, align = "c")
+tt(x, width = 0.5)
- tinytable_ghu1fmkqwq43vsgsfqfy
+ tinytable_5cthvq6k97urueuavt0v
@@ -907,138 +828,58 @@ Alignment
-
+
- a
- b
- c
+ mpg
+ cyl
+ disp
+ hp
+ drat
- a
- b
- c
-
-
- aa
- bb
- cc
+ 21
+ 6
+ 160
+ 110
+ 3.9
- aaa
- bbb
- ccc
-
-
-
-
-
-
-
-
-
-
-
-tt(dat) |> style_tt(j = 1:3, align = "lcr")
-
-
-
-
-
-
- tinytable_ulhrdw03vg2d9ev18bg6
-
-
-
-
-
-
-
-
-
-
-
-
- a
- b
- c
-
-
-
-
-
- a
- b
- c
+ 21
+ 6
+ 160
+ 110
+ 3.9
- aa
- bb
- cc
+ 22.8
+ 4
+ 108
+ 93
+ 3.85
- aaa
- bbb
- ccc
+ 21.4
+ 6
+ 258
+ 110
+ 3.08
@@ -1068,28 +899,17 @@ Alignment
-
-
-Formatting (numbers, dates, strings, etc.)
-The tt() function is minimalist; it’s inteded purpose is simply to draw nice tables. Users who want to format numbers, dates, strings, and other variables in different ways should process their data before supplying it to the tt() table-drawing function. To do so, we can use the format_tt() function supplied by the tinytable.
-In a very simple case—such as printing 2 significant digits of all numeric variables—we can use the digits argument of tt():
-dat <- data.frame(
- w = c(143002.2092, 201399.181, 100188.3883),
- x = c(1.43402, 201.399, 0.134588),
- y = as.Date(sample(1:1000, 3)),
- z = c(TRUE, TRUE, FALSE))
-
-tt(dat, digits = 2)
+tt(x, width = 1)
- tinytable_otjlh1vsr4wc97pdv7eu
+ tinytable_zs61ffpauk2rf8zk8f86
@@ -1107,145 +927,58 @@ Form
-
+
- w
- x
- y
- z
+ mpg
+ cyl
+ disp
+ hp
+ drat
- 143002
- 1.43
- 1972-09-16
- True
-
-
- 201399
- 201.40
- 1970-11-16
- True
+ 21
+ 6
+ 160
+ 110
+ 3.9
- 100188
- 0.13
- 1970-06-04
- False
-
-
-
-
-
-
-
-
-
-
-
-
-We can get more fine-grained control over formatting by calling format_tt() after tt(), optionally by specifying the columns to format with j:
-
-tt(dat) |>
- format_tt(
- j = 2:4,
- digits = 1,
- date = "%B %d %Y") |>
- format_tt(
- j = 1,
- digits = 2,
- num_mark_big = " ",
- num_mark_dec = ",",
- num_fmt = "decimal")
-
-
-
-
-
-
- tinytable_f34iqa8wsklp5lyzbbk3
-
-
-
-
-
-
-
-
-
-
-
-
- w
- x
- y
- z
-
-
-
-
-
- 143 002,21
- 1.4
- September 16 1972
- True
+ 21
+ 6
+ 160
+ 110
+ 3.9
- 201 399,18
- 201.4
- November 16 1970
- True
+ 22.8
+ 4
+ 108
+ 93
+ 3.85
- 100 188,39
- 0.1
- June 04 1970
- False
+ 21.4
+ 6
+ 258
+ 110
+ 3.08
@@ -1264,25 +998,38 @@ Form
-We can use a regular expression in j to select columns, and the ?sprintf function to format strings, numbers, and to do string interpolation (similar to the glue package, but using Base R):
+
+
+Captions and cross-references
+In Quarto, one can specify captions and use cross-references using code like this:
+@tbl-blah shows that...
+
+```{r}
+#| label: tbl-blah
+#| tbl-cap: "Blah blah blah"
+library(tinytable)
+tt(mtcars[1:4, 1:4])
+```
+And here is the rendered version of the code chunk above:
+Table 1 shows that…
-dat <- data.frame(
- a = c("Burger", "Halloumi", "Tofu", "Beans"),
- b = c(1.43202, 201.399, 0.146188, 0.0031),
- c = c(98938272783457, 7288839482, 29111727, 93945))
-tt(dat) |>
- format_tt(j = "a", sprintf = "Food: %s") |>
- format_tt(j = 2, digits = 1) |>
- format_tt(j = "c", digits = 2, num_suffix = TRUE)
+library(tinytable)
+tt(mtcars[1:4, 1:4], placement = NULL)
+
+
+
+Table 1: Blah blah blah
+
+
- tinytable_8erslhcdbkpaonxiweje
+ tinytable_thdlpxw5ybgtxx701i4l
@@ -1300,48 +1047,53 @@ Form
-
+
- a
- b
- c
+ mpg
+ cyl
+ disp
+ hp
- Food: Burger
- 1.432
- 98.94T
+ 21
+ 6
+ 160
+ 110
- Food: Halloumi
- 201.399
- 7.29B
+ 21
+ 6
+ 160
+ 110
- Food: Tofu
- 0.146
- 29.11M
+ 22.8
+ 4
+ 108
+ 93
- Food: Beans
- 0.003
- 93.94K
+ 21.4
+ 6
+ 258
+ 110
@@ -1359,36 +1112,36 @@ Form
-
Finally, if you like the format_tt() interface, you can use it directly with numbers, vectors, or data frames:
-
-format_tt(pi, digits = 1)
-
-[1] "3"
+
-format_tt(dat, digits = 1, num_suffix = TRUE)
-
- a b c
-1 Burger 1.4 98.9T
-2 Halloumi 201.4 7.3B
-3 Tofu 0.1 29.1M
-4 Beans 0.0 93.9K
+For standalone LaTeX tables, you can use the caption argument like so:
+
+tt(x, caption = "Blah blah.\\label{tbl-blah}")
+Be aware that this more approach may not work well in Quarto or Rmarkdown documents.
-
-Width
-The width arguments accepts a number between 0 and 1, indicating what proportion of the linewidth the table should cover:
+
+Footnotes
+The notes argument accepts single strings or named lists of strings:
-tt(x, width = 0.5)
+n <- "Fusce id ipsum consequat ante pellentesque iaculis eu a ipsum. Mauris id ex in nulla consectetur aliquam. In nec tempus diam. Aliquam arcu nibh, dapibus id ex vestibulum, feugiat consequat erat. Morbi feugiat dapibus malesuada. Quisque vel ullamcorper felis. Aenean a sem at nisi tempor pretium sit amet quis lacus."
+
+lorem <- data.frame(
+ Lorem = "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.",
+ Ipsum = " Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos."
+)
+
+tt(lorem, notes = n, width = 1)
- tinytable_ajbbpkzqao1eqdzzrbc0
+ tinytable_mrkxs5cc5xae6f6ooego
@@ -1406,58 +1159,31 @@ Width
-
+ A full-width table with wrapped text in cells and a footnote.
- mpg
- cyl
- disp
- hp
- drat
+ Lorem
+ Ipsum
-
+ Fusce id ipsum consequat ante pellentesque iaculis eu a ipsum. Mauris id ex in nulla consectetur aliquam. In nec tempus diam. Aliquam arcu nibh, dapibus id ex vestibulum, feugiat consequat erat. Morbi feugiat dapibus malesuada. Quisque vel ullamcorper felis. Aenean a sem at nisi tempor pretium sit amet quis lacus.
- 21
- 6
- 160
- 110
- 3.9
-
-
- 21
- 6
- 160
- 110
- 3.9
-
-
- 22.8
- 4
- 108
- 93
- 3.85
-
-
- 21.4
- 6
- 258
- 110
- 3.08
+ Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
+ Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos.
@@ -1477,17 +1200,18 @@ Width
+When notes is a named list, the names are used as identifiers and displayed as superscripts:
-tt(x, width = 1)
+tt(x, notes = list(a = "Blah.", b = "Blah blah."))
- tinytable_aft1cs5iydpwrbsf274n
+ tinytable_v70c60ukdimviirw7kc8
@@ -1505,7 +1229,7 @@ Width
-
+
@@ -1516,7 +1240,8 @@ Width
drat
-
+ a Blah. b Blah blah.
21
@@ -1551,12 +1276,12 @@ Width
@@ -1581,20 +1306,16 @@ Width
Line breaks and text wrapping
When the width argument is specified and a cell includes long text, the text is automatically wrapped to match the table.
-lorem <- data.frame(
- Lorem = "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.",
- Ipsum = " Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos."
-)
-tt(lorem, width = 3/4)
+tt(lorem, width = 3/4)
- tinytable_f331y4dmybh0r0q7cudi
+ tinytable_qbegz2p3tedwd7l23o58
@@ -1612,7 +1333,7 @@ Line breaks
- A full width table with wrapped text.
A full width table with wrapped text.
@@ -1631,12 +1352,12 @@ Line breaks
@@ -1655,20 +1376,20 @@ Line breaks
Manual line breaks work sligthly different in LaTeX (PDF) or HTML. This table shows the two strategies. For HTML, we insert a <br> tag. For LaTeX, we wrap the string in curly braces {}, and then insert two (escaped) backslashes: \\\\
-d <- data.frame(
- "{Sed ut \\\\ perspiciatis unde}",
- "dicta sunt<br> explicabo. Nemo"
-) |> setNames(c("LaTeX line break", "HTML line break"))
-tt(d, width = 1)
+d <- data.frame(
+ "{Sed ut \\\\ perspiciatis unde}",
+ "dicta sunt<br> explicabo. Nemo"
+) |> setNames(c("LaTeX line break", "HTML line break"))
+tt(d, width = 1)
- tinytable_zn31yzac3dutfjr2kqk6
+ tinytable_xw1m576f763umf7fsc12
@@ -1686,7 +1407,7 @@ Line breaks
-
+
@@ -1705,12 +1426,12 @@ Line breaks
@@ -1728,37 +1449,25 @@ Line breaks
-
-Captions and cross-references
-In Quarto, one can specify captions and use cross-references using code like this:
-@tbl-blah shows that...
-
-```{r}
-#| label: tbl-blah
-#| tbl-cap: "Blah blah blah"
-library(tinytable)
-tt(mtcars[1:4, 1:4])
-```
-And here is the rendered version of the code chunk above:
-Table 1 shows that…
+
+Math
+To insert LaTeX-style mathematical expressions in a tinytable, we enclose the expression in dollar signs: $...$. The expression will then rendered as a mathematical expression by MathJax (for HTML), LaTeX, or Pandoc. Do not forget to double escape any backslashes.
-library(tinytable)
-tt(mtcars[1:4, 1:4], placement = NULL)
-
-
-
-Table 1: Blah blah blah
-
-
+dat <- data.frame(Math = c(
+ "$x^2 + y^2 = z^2$",
+ "$\\frac{1}{2}$"
+))
+tt(dat) |> style_tt(j = 1, align = "c")
- tinytable_7nwz2rn468b4yuc7t94j
+ tinytable_xnoh0l1oey8t6nbsjz95
@@ -1776,53 +1485,32 @@ Captions and
-
+
- mpg
- cyl
- disp
- hp
+ Math
- 21
- 6
- 160
- 110
-
-
- 21
- 6
- 160
- 110
-
-
- 22.8
- 4
- 108
- 93
+ $x^2 + y^2 = z^2$
- 21.4
- 6
- 258
- 110
+ $\frac{1}{2}$
@@ -1841,31 +1529,107 @@ Captions and
-
+
+
+
+Output formats: save_tt()
+tinytable can produce tables in HTML, Word, Markdown, LaTeX, PDF, or PNG format. An appropriate output format for printing is automatically selected based on (1) whether the function is called interactively, (2) is called within RStudio, and (3) the output format of the Rmarkdown or Quarto document, if applicable. Alternatively, users can specify the print format in print() or by setting a global option:
+
+tt(x) |> print("markdown")
+tt(x) |> print("html")
+tt(x) |> print("latex")
+
+options(tinytable_print_output = "markdown")
+
+With the save_tt() function, users can also save tables directly to PNG (images), PDF or Word documents, and to any of the basic formats. All we need to do is supply a valid file name with the appropriate extension (ex: .png, .html, .pdf, etc.):
+tt(x) |> save_tt("path/to/file.png")
+tt(x) |> save_tt("path/to/file.pdf")
+tt(x) |> save_tt("path/to/file.docx")
+tt(x) |> save_tt("path/to/file.html")
+tt(x) |> save_tt("path/to/file.tex")
+tt(x) |> save_tt("path/to/file.md")
+save_tt() can also return a string with the table in it, for further processing in R. In the first case, the table is printed to console with cat(). In the second case, it returns as a single string as an R object.
+
+tt(mtcars[1:10, 1:5]) |>
+ group_tt(
+ i = list(
+ "Hello" = 3,
+ "World" = 8),
+ j = list(
+ "Foo" = 2:3,
+ "Bar" = 4:5)) |>
+ print("markdown")
+
+
++------+-------------+------------+
+| | Foo | Bar |
++------+-----+-------+-----+------+
+| mpg | cyl | disp | hp | drat |
++======+=====+=======+=====+======+
+| 21 | 6 | 160 | 110 | 3.9 |
++------+-----+-------+-----+------+
+| 21 | 6 | 160 | 110 | 3.9 |
++------+-----+-------+-----+------+
+| Hello |
++------+-----+-------+-----+------+
+| 22.8 | 4 | 108 | 93 | 3.85 |
++------+-----+-------+-----+------+
+| 21.4 | 6 | 258 | 110 | 3.08 |
++------+-----+-------+-----+------+
+| 18.7 | 8 | 360 | 175 | 3.15 |
++------+-----+-------+-----+------+
+| 18.1 | 6 | 225 | 105 | 2.76 |
++------+-----+-------+-----+------+
+| 14.3 | 8 | 360 | 245 | 3.21 |
++------+-----+-------+-----+------+
+| World |
++------+-----+-------+-----+------+
+| 24.4 | 4 | 146.7 | 62 | 3.69 |
++------+-----+-------+-----+------+
+| 22.8 | 4 | 140.8 | 95 | 3.92 |
++------+-----+-------+-----+------+
+| 19.2 | 6 | 167.6 | 123 | 3.92 |
++------+-----+-------+-----+------+
-For standalone LaTeX tables, you can use the caption argument like so:
-tt(x, caption = "Blah blah.\\label{tbl-blah}")
+tt(mtcars[1:10, 1:5]) |>
+ group_tt(
+ i = list(
+ "Hello" = 3,
+ "World" = 8),
+ j = list(
+ "Foo" = 2:3,
+ "Bar" = 4:5)) |>
+ save_tt("markdown")
+
+[1] "+------+-------------+------------+\n| | Foo | Bar |\n+------+-----+-------+-----+------+\n| mpg | cyl | disp | hp | drat |\n+======+=====+=======+=====+======+\n| 21 | 6 | 160 | 110 | 3.9 |\n+------+-----+-------+-----+------+\n| 21 | 6 | 160 | 110 | 3.9 |\n+------+-----+-------+-----+------+\n| Hello |\n+------+-----+-------+-----+------+\n| 22.8 | 4 | 108 | 93 | 3.85 |\n+------+-----+-------+-----+------+\n| 21.4 | 6 | 258 | 110 | 3.08 |\n+------+-----+-------+-----+------+\n| 18.7 | 8 | 360 | 175 | 3.15 |\n+------+-----+-------+-----+------+\n| 18.1 | 6 | 225 | 105 | 2.76 |\n+------+-----+-------+-----+------+\n| 14.3 | 8 | 360 | 245 | 3.21 |\n+------+-----+-------+-----+------+\n| World |\n+------+-----+-------+-----+------+\n| 24.4 | 4 | 146.7 | 62 | 3.69 |\n+------+-----+-------+-----+------+\n| 22.8 | 4 | 140.8 | 95 | 3.92 |\n+------+-----+-------+-----+------+\n| 19.2 | 6 | 167.6 | 123 | 3.92 |\n+------+-----+-------+-----+------+"
+
-Be aware that this more approach may not work well in Quarto or Rmarkdown documents.
-
-Footnotes
-The notes argument accepts single strings or named lists of strings:
+
+Formatting content: format_tt()
+
+Numbers, dates, strings, etc.
+The tt() function is minimalist; it’s inteded purpose is simply to draw nice tables. Users who want to format numbers, dates, strings, and other variables in different ways should process their data before supplying it to the tt() table-drawing function. To do so, we can use the format_tt() function supplied by the tinytable.
+In a very simple case—such as printing 2 significant digits of all numeric variables—we can use the digits argument of tt():
-n <- "Fusce id ipsum consequat ante pellentesque iaculis eu a ipsum. Mauris id ex in nulla consectetur aliquam. In nec tempus diam. Aliquam arcu nibh, dapibus id ex vestibulum, feugiat consequat erat. Morbi feugiat dapibus malesuada. Quisque vel ullamcorper felis. Aenean a sem at nisi tempor pretium sit amet quis lacus."
-
-tt(lorem, notes = n, width = 1)
+dat <- data.frame(
+ w = c(143002.2092, 201399.181, 100188.3883),
+ x = c(1.43402, 201.399, 0.134588),
+ y = as.Date(sample(1:1000, 3)),
+ z = c(TRUE, TRUE, FALSE))
+
+tt(dat, digits = 2)
- tinytable_3mjl6w7074z2662hoajk
+ tinytable_9l6jql857lenqoypv2n5
@@ -1883,31 +1647,47 @@ Footnotes
- A full-width table with wrapped text in cells and a footnote.
- Lorem
- Ipsum
+ w
+ x
+ y
+ z
- Fusce id ipsum consequat ante pellentesque iaculis eu a ipsum. Mauris id ex in nulla consectetur aliquam. In nec tempus diam. Aliquam arcu nibh, dapibus id ex vestibulum, feugiat consequat erat. Morbi feugiat dapibus malesuada. Quisque vel ullamcorper felis. Aenean a sem at nisi tempor pretium sit amet quis lacus.
- Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
- Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos.
+ 143002
+ 1.43
+ 1971-01-13
+ True
+
+
+ 201399
+ 201.40
+ 1972-07-13
+ True
+
+
+ 100188
+ 0.13
+ 1970-03-03
+ False
@@ -1924,18 +1706,28 @@ Footnotes
-When notes is a named list, the names are used as identifiers and displayed as superscripts:
+We can get more fine-grained control over formatting by calling format_tt() after tt(), optionally by specifying the columns to format with j:
-tt(x, notes = list(a = "Blah.", b = "Blah blah."))
+tt(dat) |>
+ format_tt(
+ j = 2:4,
+ digits = 1,
+ date = "%B %d %Y") |>
+ format_tt(
+ j = 1,
+ digits = 2,
+ num_mark_big = " ",
+ num_mark_dec = ",",
+ num_fmt = "decimal")
- tinytable_g7kcqtks5nwr697n1vm7
+ tinytable_mfqjwewhfuhy9mhynvas
@@ -1953,59 +1745,47 @@ Footnotes
-
+
- mpg
- cyl
- disp
- hp
- drat
+ w
+ x
+ y
+ z
- a Blah. b Blah blah.
- 21
- 6
- 160
- 110
- 3.9
-
-
- 21
- 6
- 160
- 110
- 3.9
+ 143 002,21
+ 1.4
+ January 13 1971
+ True
- 22.8
- 4
- 108
- 93
- 3.85
+ 201 399,18
+ 201.4
+ July 13 1972
+ True
- 21.4
- 6
- 258
- 110
- 3.08
+ 100 188,39
+ 0.1
+ March 03 1970
+ False
@@ -2025,26 +1804,25 @@ Footnotes
-
-
-Math
-To insert LaTeX-style mathematical expressions in a tinytable, we enclose the expression in dollar signs: $...$. The expression will then rendered as a mathematical expression by MathJax (for HTML), LaTeX, or Pandoc. Do not forget to double escape any backslashes.
+We can use a regular expression in j to select columns, and the ?sprintf function to format strings, numbers, and to do string interpolation (similar to the glue package, but using Base R):
-dat <- data.frame(Math = c(
- "$x^2 + y^2 = z^2$",
- "$\\frac{1}{2}$"
-))
-tt(dat) |> style_tt(j = 1, align = "c")
+dat <- data.frame(
+ a = c("Burger", "Halloumi", "Tofu", "Beans"),
+ b = c(1.43202, 201.399, 0.146188, 0.0031),
+ c = c(98938272783457, 7288839482, 29111727, 93945))
+tt(dat) |>
+ format_tt(j = "a", sprintf = "Food: %s") |>
+ format_tt(j = 2, digits = 1) |>
+ format_tt(j = "c", digits = 2, num_suffix = TRUE)
- tinytable_z02lq1f30t09kw4qlgc8
+ tinytable_ekkuagw1mkyz6qvj79er
@@ -2062,32 +1840,48 @@ Math
-
+
- Math
+ a
+ b
+ c
- $x^2 + y^2 = z^2$
+ Food: Burger
+ 1.432
+ 98.94T
- $\frac{1}{2}$
+ Food: Halloumi
+ 201.399
+ 7.29B
+
+
+ Food: Tofu
+ 0.146
+ 29.11M
+
+
+ Food: Beans
+ 0.003
+ 93.94K
+
+
+Finally, if you like the format_tt() interface, you can use it directly with numbers, vectors, or data frames:
+
+format_tt(pi, digits = 1)
+
+[1] "3"
+
+format_tt(dat, digits = 1, num_suffix = TRUE)
+
+ a b c
+1 Burger 1.4 98.9T
+2 Halloumi 201.4 7.3B
+3 Tofu 0.1 29.1M
+4 Beans 0.0 93.9K
@@ -2111,24 +1919,24 @@ Math
Markdown
Markdown can be rendered in cells by using the markdown argument of the format_tt() function (note: this requires installing the markdown as an optional dependency).
-dat <- data.frame( markdown = c(
- "This is _italic_ text.",
- "This sentence ends with a superscript.^2^")
-)
-
-tt(dat) |>
- format_tt(j = 1, markdown = TRUE) |>
- style_tt(j = 1, align = "c")
+dat <- data.frame( markdown = c(
+ "This is _italic_ text.",
+ "This sentence ends with a superscript.^2^")
+)
+
+tt(dat) |>
+ format_tt(j = 1, markdown = TRUE) |>
+ style_tt(j = 1, align = "c")
- tinytable_stt52p2lsnhvxdu158n2
+ tinytable_oi7gg8skpyvwg6542jb0
@@ -2146,7 +1954,7 @@ Markdown
-
+
@@ -2166,12 +1974,12 @@ Markdown
@@ -2192,46 +2000,46 @@ Markdown
Markdown syntax can be particularly useful when formatting URLs in a table:
-dat <- data.frame(
- `Package (link)` = c(
- "[`marginaleffects`](https://www.marginaleffects.com/)",
- "[`modelsummary`](https://www.modelsummary.com/)",
- "[`tinytable`](https://vincentarelbundock.github.io/tinytable/)",
- "[`countrycode`](https://vincentarelbundock.github.io/countrycode/)",
- "[`WDI`](https://vincentarelbundock.github.io/WDI/)",
- "[`softbib`](https://vincentarelbundock.github.io/softbib/)",
- "[`tinysnapshot`](https://vincentarelbundock.github.io/tinysnapshot/)",
- "[`altdoc`](https://etiennebacher.github.io/altdoc/)",
- "[`plot2`](https://grantmcdermott.com/plot2/)",
- "[`parameters`](https://easystats.github.io/parameters/)",
- "[`insight`](https://easystats.github.io/insight/)"
- ),
- Purpose = c(
- "Interpreting statistical models",
- "Data and model summaries",
- "Draw beautiful tables easily",
- "Convert country codes and names",
- "Download data from the World Bank",
- "Software bibliographies in R",
- "Snapshots for unit tests using `tinytest`",
- "Create documentation website for R packages",
- "Extension of base R plot functions",
- "Extract from model objects",
- "Extract information from model objects"
- ),
- check.names = FALSE
-)
-
-tt(dat) |> format_tt(j = 1, markdown = TRUE)
+dat <- data.frame(
+ `Package (link)` = c(
+ "[`marginaleffects`](https://www.marginaleffects.com/)",
+ "[`modelsummary`](https://www.modelsummary.com/)",
+ "[`tinytable`](https://vincentarelbundock.github.io/tinytable/)",
+ "[`countrycode`](https://vincentarelbundock.github.io/countrycode/)",
+ "[`WDI`](https://vincentarelbundock.github.io/WDI/)",
+ "[`softbib`](https://vincentarelbundock.github.io/softbib/)",
+ "[`tinysnapshot`](https://vincentarelbundock.github.io/tinysnapshot/)",
+ "[`altdoc`](https://etiennebacher.github.io/altdoc/)",
+ "[`plot2`](https://grantmcdermott.com/plot2/)",
+ "[`parameters`](https://easystats.github.io/parameters/)",
+ "[`insight`](https://easystats.github.io/insight/)"
+ ),
+ Purpose = c(
+ "Interpreting statistical models",
+ "Data and model summaries",
+ "Draw beautiful tables easily",
+ "Convert country codes and names",
+ "Download data from the World Bank",
+ "Software bibliographies in R",
+ "Snapshots for unit tests using `tinytest`",
+ "Create documentation website for R packages",
+ "Extension of base R plot functions",
+ "Extract from model objects",
+ "Extract information from model objects"
+ ),
+ check.names = FALSE
+)
+
+tt(dat) |> format_tt(j = 1, markdown = TRUE)
- tinytable_ejtw704nzfx22k9f2wji
+ tinytable_a4aov2lb3j9beb8g6mku
@@ -2249,7 +2057,7 @@ Markdown
- Vincent sometimes contributes to these R packages.
Vincent sometimes contributes to these R packages.
@@ -2308,12 +2116,12 @@ Markdown
@@ -2332,8 +2140,8 @@ Markdown
-
-Style
+
+Style: style_tt()
The main styling function for the tinytable package is style_tt(). Via this function, you can access three main interfaces to customize tables:
- A general interface to frequently used style choices which works for both HTML and LaTeX (PDF): colors, font style and size, row and column spans, etc. This is accessed through several distinct arguments in the
style_tt() function, such as italic, color, etc.
@@ -2360,22 +2168,22 @@ Style
Cells, rows, columns
To style individual cells, we use the style_cell() function. The first two arguments—i and j—identify the cells of interest, by row and column numbers respectively. To style a cell in the 2nd row and 3rd column, we can do:
-tt(x) |>
- style_tt(
- i = 2,
- j = 3,
- background = "black",
- color = "white")
+tt(x) |>
+ style_tt(
+ i = 2,
+ j = 3,
+ background = "black",
+ color = "white")
- tinytable_mcc67y9zhoczbtl35lq7
+ tinytable_ryxwvh24zyyfbb1imbgd
@@ -2393,7 +2201,7 @@ Cells, rows, columns
-
+
@@ -2439,12 +2247,12 @@ Cells, rows, columns
@@ -2467,22 +2275,22 @@ Cells, rows, columns
The i and j accept vectors of integers to modify several cells at once:
-tt(x) |>
- style_tt(
- i = 2:3,
- j = c(1, 3, 4),
- italic = TRUE,
- color = "orange")
+tt(x) |>
+ style_tt(
+ i = 2:3,
+ j = c(1, 3, 4),
+ italic = TRUE,
+ color = "orange")
- tinytable_0hdjvpthwz0c83twxdr9
+ tinytable_4skaf7admzeg85a4c97w
@@ -2500,7 +2308,7 @@ Cells, rows, columns
-
+
@@ -2546,12 +2354,12 @@ Cells, rows, columns
@@ -2579,17 +2387,17 @@ Cells, rows, columns
We can style all cells in a table by omitting both the i and j arguments:
-tt(x) |> style_tt(color = "orange")
+tt(x) |> style_tt(color = "orange")
- tinytable_a7decaxcd2wcj78t06q3
+ tinytable_bhl6rvelig1tskm1o6tz
@@ -2607,7 +2415,7 @@ Cells, rows, columns
-
+
@@ -2653,12 +2461,12 @@ Cells, rows, columns
@@ -2700,17 +2508,17 @@ Cells, rows, columns
We can style entire rows by omitting the j argument:
-tt(x) |> style_tt(i = 1:2, color = "orange")
+tt(x) |> style_tt(i = 1:2, color = "orange")
- tinytable_stk1xvg022v8kba2jetz
+ tinytable_xc1sep3h6a4loxt8ofcd
@@ -2728,7 +2536,7 @@ Cells, rows, columns
-
+
@@ -2774,12 +2582,12 @@ Cells, rows, columns
@@ -2811,17 +2619,17 @@ Cells, rows, columns
We can style entire columns by omitting the i argument:
-tt(x) |> style_tt(j = c(2, 4), bold = TRUE)
+tt(x) |> style_tt(j = c(2, 4), bold = TRUE)
- tinytable_vmpvvwg787pau5ed9vsk
+ tinytable_6r517hmi6d335sut28we
@@ -2839,7 +2647,7 @@ Cells, rows, columns
-
+
@@ -2885,12 +2693,12 @@ Cells, rows, columns
@@ -2922,17 +2730,17 @@ Cells, rows, columns
The j argument accepts integer vectors, but also a string with a Perl-style regular expression, which makes it easier to select columns by name:
-tt(x) |> style_tt(j = "mpg|drat", color = "orange")
+tt(x) |> style_tt(j = "mpg|drat", color = "orange")
- tinytable_w5orkop93jgc2stmhq5k
+ tinytable_et9pzdl5om5xdoo38h2y
@@ -2950,7 +2758,7 @@ Cells, rows, columns
-
+
@@ -2996,12 +2804,12 @@ Cells, rows, columns
@@ -3033,20 +2841,20 @@ Cells, rows, columns
Of course, we can also call the style_tt() function several times to apply different styles to different parts of the table:
-tt(x) |>
- style_tt(i = 1, j = 1:2, color = "orange") |>
- style_tt(i = 1, j = 3:4, color = "green")
+tt(x) |>
+ style_tt(i = 1, j = 1:2, color = "orange") |>
+ style_tt(i = 1, j = 3:4, color = "green")
- tinytable_ar9qd45jijti9nxkzbl2
+ tinytable_a8xfr4m7ju9blqjhhmqe
@@ -3064,7 +2872,7 @@ Cells, rows, columns
-
+
@@ -3110,12 +2918,12 @@ Cells, rows, columns
@@ -3157,17 +2965,17 @@ Colors
Note that the keywords used in LaTeX and HTML are slightly different.
-tt(x) |> style_tt(i = 1:4, j = 1, color = "#FF5733")
+tt(x) |> style_tt(i = 1:4, j = 1, color = "#FF5733")
- tinytable_f940w5uyr11msudkrfi3
+ tinytable_lmicvbmhzqoffnl6snxm
@@ -3185,7 +2993,7 @@ Colors
-
+
@@ -3231,12 +3039,12 @@ Colors
@@ -3262,6 +3070,205 @@ Colors
Note that when using Hex codes in a LaTeX table, we need extra declarations in the LaTeX preamble. See ?tt for details.
+
+Alignment
+To align columns, we use a single character, or a string where each letter represents a column:
+
+dat <- data.frame(
+ a = c("a", "aa", "aaa"),
+ b = c("b", "bb", "bbb"),
+ c = c("c", "cc", "ccc"))
+
+tt(dat) |> style_tt(j = 1:3, align = "c")
+
+
+
+
+
+
+ tinytable_ky3q1cbo1bn9avf423no
+
+
+
+
+
+
+
+
+
+
+
+
+ a
+ b
+ c
+
+
+
+
+
+ a
+ b
+ c
+
+
+ aa
+ bb
+ cc
+
+
+ aaa
+ bbb
+ ccc
+
+
+
+
+
+
+
+
+
+
+
+tt(dat) |> style_tt(j = 1:3, align = "lcr")
+
+
+
+
+
+
+ tinytable_yekdcq0a1gknz3qg57ai
+
+
+
+
+
+
+
+
+
+
+
+
+ a
+ b
+ c
+
+
+
+
+
+ a
+ b
+ c
+
+
+ aa
+ bb
+ cc
+
+
+ aaa
+ bbb
+ ccc
+
+
+
+
+
+
+
+
+
+
+
+
+
Fonts
The font size is specified in em units.
@@ -3273,10 +3280,10 @@ Fonts
- tinytable_ohelvt1iyhsrvipiomkl
+ tinytable_myxo7ly1a0ey9hr0wnek
@@ -3294,7 +3301,7 @@ Fonts
-
+
@@ -3340,12 +3347,12 @@ Fonts
@@ -3389,9 +3396,9 @@ Headers
- tinytable_ripj208ouuypt1wvwlu7
+ tinytable_u550veqwwrrawb75squ2
@@ -3409,7 +3416,7 @@ Headers
-
+
@@ -3448,12 +3455,12 @@ Headers
@@ -3482,10 +3489,10 @@ Headers
- tinytable_lvwrfm9oo3mhm01jvjtb
+ tinytable_napy0tzqhwsg49ybmv75
@@ -3503,7 +3510,7 @@ Headers
-
+
@@ -3549,12 +3556,12 @@ Headers
@@ -3588,10 +3595,10 @@ Headers
- tinytable_trq2sd4nwr58hay8jxhd
+ tinytable_gj7amndve79wox5t7yxi
@@ -3609,7 +3616,7 @@ Headers
-
+
@@ -3655,12 +3662,12 @@ Headers
@@ -3708,10 +3715,10 @@ Conditional styling
- tinytable_8s59n89kozhipfkmj0n7
+ tinytable_1s55fhvo85fds8iti1uh
@@ -3729,7 +3736,7 @@ Conditional styling
-
+
@@ -3795,12 +3802,12 @@ Conditional styling
@@ -3842,13 +3849,13 @@ Vectorized sty
- tinytable_w9s67lnjkaxhxpf2mi7e
+ tinytable_y4we0jlzq13dfh59v1tv
@@ -3866,7 +3873,7 @@ Vectorized sty
-
+
@@ -3912,12 +3919,12 @@ Vectorized sty
@@ -3970,11 +3977,11 @@ Vectorized sty
- tinytable_m9gztozqi3hdshq5rl37
+ tinytable_fov7hgr4fphsh6rocnve
@@ -3992,7 +3999,7 @@ Vectorized sty
-
+
@@ -4038,12 +4045,12 @@ Vectorized sty
@@ -4101,30 +4108,30 @@ Vectorized sty
- tinytable_2rowcapqhhjjcvzerl6b
+ tinytable_9q1g02vn2p78lcarqo6y
@@ -4142,7 +4149,7 @@ Vectorized sty
-
+
@@ -4181,12 +4188,12 @@ Vectorized sty
@@ -4292,10 +4299,10 @@ Lines (borders)
- tinytable_qfhs5jo3e3izc1ttja3s
+ tinytable_0r0s0vs362owdbgj30cj
@@ -4313,7 +4320,7 @@ Lines (borders)
-
+
@@ -4359,12 +4366,12 @@ Lines (borders)
@@ -4423,12 +4430,12 @@ Lines (borders)
- tinytable_je8oummvitcvhvcrmu84
+ tinytable_7klek3ruy054dsair2sf
@@ -4446,7 +4453,7 @@ Lines (borders)
-
+
@@ -4492,12 +4499,12 @@ Lines (borders)
@@ -4549,8 +4556,8 @@ Lines (borders)
-
-Tiny plots and images
+
+Plots and images: plot_tt()
The plot_tt() function can embed images and plots in a tinytable. We can insert images by specifying their paths and positions (i/j).
Inserting images in tables
@@ -4574,9 +4581,9 @@ Inserting image
- tinytable_td0qibt9aaqk0jtkbnmc
+ tinytable_ish771xwslqd459l8v4b
@@ -4594,7 +4601,7 @@ Inserting image
Print a tinytable to console or viewer pane
+Description
+Print a tinytable to console or viewer pane
+Usage
+## S3 method for class 'tinytable'
+print(x, output = getOption("tinytable_print_output", default = NULL), ...)
+Arguments
+
+x
+ |
++A data frame or data table to be rendered as a table. + | +
+output
+ |
++One of "latex", "markdown", "html". If NULL, will guess the output based on the environment (interactive, RStudio, etc.). + | +
+…
+ |
++Other arguments are ignored. + | +
Value
+launch a browser window or cat() the table to console.
+ + +