Type: | Package |
Title: | Simple and Configurable Tables in 'HTML', 'LaTeX', 'Markdown', 'Word', 'PNG', 'PDF', and 'Typst' Formats |
Description: | Create highly customized tables with this simple and dependency-free package. Data frames can be converted to 'HTML', 'LaTeX', 'Markdown', 'Word', 'PNG', 'PDF', or 'Typst' tables. The user interface is minimalist and easy to learn. The syntax is concise. 'HTML' tables can be customized using the flexible 'Bootstrap' framework, and 'LaTeX' code with the 'tabularray' package. |
Version: | 0.14.0 |
Imports: | methods |
Depends: | R (≥ 4.1.0) |
Enhances: | knitr |
Suggests: | base64enc, broom, data.table (≥ 1.15.2), estimatr, ggplot2, gh, glue, htmltools, litedown (≥ 0.6), magrittr, marginaleffects, modelsummary, pandoc, quarto, Rdatasets, rmarkdown, rstudioapi, scales, stringi, tibble, tinysnapshot (≥ 0.2.0), tinytest, tinytex, xfun (≥ 0.51), webshot2 |
URL: | https://vincentarelbundock.github.io/tinytable/ |
BugReports: | https://github.com/vincentarelbundock/tinytable/issues |
License: | GPL (≥ 3) |
Encoding: | UTF-8 |
RoxygenNote: | 7.3.2 |
NeedsCompilation: | no |
Packaged: | 2025-09-29 11:18:34 UTC; vincent |
Author: | Vincent Arel-Bundock
|
Maintainer: | Vincent Arel-Bundock <vincent.arel-bundock@umontreal.ca> |
Repository: | CRAN |
Date/Publication: | 2025-09-29 12:10:02 UTC |
Simple and Configurable Tables in 'HTML', 'LaTeX', 'Markdown', 'Word', 'PNG', 'PDF', and 'Typst' Formats
Description
Create highly customized tables with this simple and dependency-free package. Data frames can be converted to 'HTML', 'LaTeX', 'Markdown', 'Word', 'PNG', 'PDF', or 'Typst' tables. The user interface is minimalist and easy to learn. The syntax is concise. 'HTML' tables can be customized using the flexible 'Bootstrap' framework, and 'LaTeX' code with the 'tabularray' package.
Package Content
Index of help topics:
format_tt Format columns of a data frame format_vector Format a Vector group_tt Spanning labels to identify groups of rows or columns plot_tt Insert images and inline plots into tinytable objects plot_vector Create Plot Vector print.tinytable Print, display, or convert a tinytable object rbind2,tinytable,tinytable-method Combine 'tinytable' objects by rows (vertically) save_tt Save a Tiny Table to File style_tt Style a Tiny Table style_vector Style a Vector with Text Formatting subset.tinytable Subsetting a 'tinytable' object theme_default Default theme for TinyTable theme_empty Theme for a void table theme_grid Grid theme with borders around all cells theme_html HTML-specific styles and options theme_latex LaTeX-Specific Theme for 'tinytable' theme_markdown Markdown theme with optional ANSI color support and grid customization theme_revealjs RevealJS presentation theme theme_rotate Rotate table theme (LaTeX and Typst only) theme_striped Striped theme with alternating row colors theme_tt Deprecated: Use format-specific theme functions instead theme_typst Typst-specific styles and options tinytable-package Simple and Configurable Tables in 'HTML', 'LaTeX', 'Markdown', 'Word', 'PNG', 'PDF', and 'Typst' Formats tt Draw a Tiny Table
Maintainer
Vincent Arel-Bundock <vincent.arel-bundock@umontreal.ca>
Author(s)
Vincent Arel-Bundock [aut, cre] (ORCID: <https://orcid.org/0000-0003-2042-7063>)
Convert a tinytable S4 object to a string
Description
Convert a tinytable S4 object to a string
Usage
## S4 method for signature 'tinytable'
as.character(x)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
Apply group settings to a tinytable
Description
Apply group settings to a tinytable
Usage
build_eval(x, ...)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
... |
Additional arguments are ignored |
Method for a tinytable S4 object
Description
Method for a tinytable S4 object
Usage
## S4 replacement method for signature 'tinytable'
colnames(x) <- value
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
Method for a tinytable S4 object
Description
Method for a tinytable S4 object
Usage
## S4 method for signature 'tinytable'
colnames(x)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
Convert data frame or list to JSON
Description
Simple helper function to convert a data frame or list to JSON format
Usage
df_to_json(data)
Arguments
data |
A data frame or list to convert to JSON |
Value
JSON string
Dimensions a tinytable S4 object
Description
Dimensions a tinytable S4 object
Usage
## S4 method for signature 'tinytable'
dim(x)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
Apply final settings to a tinytable
Description
Apply final settings to a tinytable
Usage
finalize(x, ...)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
... |
Additional arguments are ignored |
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_dataframe'
finalize(x)
Format columns of a data frame
Description
This function formats the columns of a data frame based on the column type (logical, date, numeric).
It allows various formatting options like significant digits, decimal points, and scientific notation.
It also includes custom formatting for date and boolean values.
If this function is applied several times to the same cell, the last transformation is retained and the previous calls are ignored, except for the escape
argument which can be applied to previously transformed data.
Usage
format_tt(
x,
i = NULL,
j = NULL,
digits = get_option("tinytable_format_digits", default = NULL),
num_fmt = get_option("tinytable_format_num_fmt", default = "significant"),
num_zero = get_option("tinytable_format_num_zero", default = FALSE),
num_suffix = get_option("tinytable_format_num_suffix", default = FALSE),
num_mark_big = get_option("tinytable_format_num_mark_big", default = ""),
num_mark_dec = get_option("tinytable_format_num_mark_dec", default =
getOption("OutDec", default = ".")),
date = get_option("tinytable_format_date", default = NULL),
bool = get_option("tinytable_format_bool", default = NULL),
math = get_option("tinytable_format_math", default = FALSE),
other = get_option("tinytable_format_other", default = NULL),
replace = get_option("tinytable_format_replace", default = FALSE),
escape = get_option("tinytable_format_escape", default = FALSE),
markdown = get_option("tinytable_format_markdown", default = FALSE),
quarto = get_option("tinytable_format_quarto", default = FALSE),
fn = get_option("tinytable_format_fn", default = NULL),
sprintf = get_option("tinytable_format_sprintf", default = NULL),
linebreak = get_option("tinytable_format_linebreak", default = NULL),
output = get_option("tinytable_format_output", default = NULL)
)
tt_format(
x,
i = NULL,
j = NULL,
digits = get_option("tinytable_format_digits", default = NULL),
num_fmt = get_option("tinytable_format_num_fmt", default = "significant"),
num_zero = get_option("tinytable_format_num_zero", default = FALSE),
num_suffix = get_option("tinytable_format_num_suffix", default = FALSE),
num_mark_big = get_option("tinytable_format_num_mark_big", default = ""),
num_mark_dec = get_option("tinytable_format_num_mark_dec", default =
getOption("OutDec", default = ".")),
date = get_option("tinytable_format_date", default = NULL),
bool = get_option("tinytable_format_bool", default = NULL),
math = get_option("tinytable_format_math", default = FALSE),
other = get_option("tinytable_format_other", default = NULL),
replace = get_option("tinytable_format_replace", default = FALSE),
escape = get_option("tinytable_format_escape", default = FALSE),
markdown = get_option("tinytable_format_markdown", default = FALSE),
quarto = get_option("tinytable_format_quarto", default = FALSE),
fn = get_option("tinytable_format_fn", default = NULL),
sprintf = get_option("tinytable_format_sprintf", default = NULL),
linebreak = get_option("tinytable_format_linebreak", default = NULL),
output = get_option("tinytable_format_output", default = NULL)
)
Arguments
x |
A data frame or a vector to be formatted. |
i |
Numeric vector or string.
|
j |
Column indices where the styling should be applied. Can be:
|
digits |
Number of significant digits or decimal places. |
num_fmt |
The format for numeric values; one of 'significant', 'significant_cell', 'decimal', or 'scientific'. |
num_zero |
Logical; if TRUE, trailing zeros are kept in "decimal" format (but not in "significant" format). |
num_suffix |
Logical; if TRUE display short numbers with |
num_mark_big |
Character to use as a thousands separator. |
num_mark_dec |
Decimal mark character. Default is the global option 'OutDec'. |
date |
A string passed to the |
bool |
A function to format logical columns. Defaults to title case. |
math |
Logical. If TRUE, wrap cell values in math mode |
other |
A function to format columns of other types. Defaults to |
replace |
Logical, String or Named list of vectors
|
escape |
Logical or "latex" or "html". If TRUE, escape special characters to display them as text in the format of the output of a
|
markdown |
Logical; if TRUE, render markdown syntax in cells. Ex: |
quarto |
Logical. Enable Quarto data processing and wrap cell content in a |
fn |
Function for custom formatting. Accepts a vector and returns a character vector of the same length. |
sprintf |
String passed to the |
linebreak |
NULL or a single string. If it is a string, replaces that string with appropriate line break sequences depending on the output format (HTML: |
output |
Apply formatting only if the |
Value
A data frame with formatted columns.
Global options
Options can be set with options()
and change the default behavior of tinytable. For example:
options(tinytable_tt_digits = 4) tt(head(iris))
You can set options in a script or via .Rprofile
. Note: be cautious with .Rprofile
settings as they may affect reproducibility.
Default values for function arguments
Nearly all of the package's functions retrieve their default values from global options. This allows you to set defaults once and apply them to all tables without needing to specify them each time. For example, to fix the the digits
argument of the tt()
function globally, call:
options(tinytable_tt_digits = 4)
In addition, some more specific options are available to control the behavior of the package in specific contexts.
-
tinytable_html_mathjax
: Insert MathJax scripts (warning: may conflict if MathJax is loaded elsewhere) -
tinytable_pdf_clean
: Delete temporary and log files for pdf output insave_tt()
-
tinytable_color_name_normalization
: Enable/disable automatic color name processing (default: TRUE). When enabled, R color names recognized bycol2rgb()
are converted to hex format for consistent rendering across HTML, LaTeX, and Typst formats. If R color conversion fails, LaTeX color names are used as fallback. Colors explicitly supplied as hex values with "#" prefix are passed through unchanged. Set to FALSE to disable processing and pass color names unchanged.
Quarto
The format_tt(quarto=TRUE)
argument enables Quarto data processing with some limitations:
The
\QuartoMarkdownBase64{}
LaTeX macro may not process references and markdown as expectedQuarto processing may conflict with
tinytable
styling/formatting
Options:
-
tinytable_quarto_disable_processing
: Disable Quarto cell processing
Example of Quarto-specific code in cells:
x <- data.frame(Math = "x^2^", Citation = "@Lovelace1842") fn <- function(z) sprintf("<span data-qmd='%s'></span>", z) tt(x) |> format_tt(i = 1, fn = fn)
For more details on Quarto table processing: https://quarto.org/docs/authoring/tables.html#disabling-quarto-table-processing
Examples
dat <- data.frame(
a = rnorm(3, mean = 10000),
b = rnorm(3, 10000)
)
tab <- tt(dat)
format_tt(tab,
digits = 2,
num_mark_dec = ",",
num_mark_big = " "
)
k <- tt(data.frame(x = c(0.000123456789, 12.4356789)))
format_tt(k, digits = 2, num_fmt = "significant_cell")
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, num_fmt = "decimal", num_zero = TRUE) |>
format_tt(j = "c", digits = 2, num_suffix = TRUE)
y <- tt(data.frame(x = c(123456789.678, 12435.6789)))
format_tt(y, digits = 3, num_mark_big = " ")
x <- tt(data.frame(Text = c("_italicized text_", "__bold text__")))
format_tt(x, markdown = TRUE)
# Line breaks using linebreak argument
d <- data.frame(Text = "First line<br>Second line")
tt(d) |> format_tt(linebreak = "<br>")
# Non-standard evaluation (NSE)
dat <- data.frame(
w = c(143002.2092, 201399.181, 100188.3883),
x = c(1.43402, 201.399, 0.134588),
y = as.Date(c(897, 232, 198), origin = "1970-01-01"),
z = c(TRUE, TRUE, FALSE)
)
tt(dat) |>
format_tt(i = w > 150000, j = w, digits = 0, num_mark_big = ",")
tab <- data.frame(a = c(NA, 1, 2), b = c(3, NA, 5))
tt(tab) |> format_tt(replace = "-")
dat <- data.frame(
"LaTeX" = c("Dollars $", "Percent %", "Underscore _"),
"HTML" = c("<br>", "<sup>4</sup>", "<emph>blah</emph>")
)
tt(dat) |> format_tt(escape = TRUE)
Format a Vector
Description
Format a Vector
Usage
format_vector(
x,
output = "html",
digits = NULL,
num_fmt = "significant",
num_zero = FALSE,
num_suffix = FALSE,
num_mark_big = "",
num_mark_dec = getOption("OutDec", default = "."),
date = NULL,
bool = NULL,
math = FALSE,
other = NULL,
replace = FALSE,
escape = FALSE,
markdown = FALSE,
quarto = FALSE,
fn = NULL,
sprintf = NULL,
linebreak = NULL
)
Arguments
x |
A vector to be formatted. |
output |
Output format. One of "html", "latex", "typst", "markdown", etc. |
digits |
Number of significant digits or decimal places. |
num_fmt |
The format for numeric values; one of 'significant', 'significant_cell', 'decimal', or 'scientific'. |
num_zero |
Logical; if TRUE, trailing zeros are kept in "decimal" format (but not in "significant" format). |
num_suffix |
Logical; if TRUE display short numbers with |
num_mark_big |
Character to use as a thousands separator. |
num_mark_dec |
Decimal mark character. Default is the global option 'OutDec'. |
date |
A string passed to the |
bool |
A function to format logical columns. Defaults to title case. |
math |
Logical. If TRUE, wrap cell values in math mode |
other |
A function to format columns of other types. Defaults to |
replace |
Logical, String or Named list of vectors
|
escape |
Logical or "latex" or "html". If TRUE, escape special characters to display them as text in the format of the output of a
|
markdown |
Logical; if TRUE, render markdown syntax in cells. Ex: |
quarto |
Logical. Enable Quarto data processing and wrap cell content in a |
fn |
Function for custom formatting. Accepts a vector and returns a character vector of the same length. |
sprintf |
String passed to the |
linebreak |
NULL or a single string. If it is a string, replaces that string with appropriate line break sequences depending on the output format (HTML: |
Details
This function formats a vector by passing it to format_tt()
. All formatting arguments must be of length 1 or length(x)
.
Value
A character vector with formatted values.
Examples
# Format numeric vector
format_vector(c(1234.567, 9876.543), digits = 2, num_mark_big = ",")
# Format dates
dates <- as.Date(c("2023-01-01", "2023-12-31"))
format_vector(dates, date = "%B %d, %Y")
# Format logical values
format_vector(c(TRUE, FALSE, TRUE), bool = function(x) ifelse(x, "Yes", "No"))
Apply group settings to a tinytable
Description
Apply group settings to a tinytable
Usage
group_eval_j(x, ...)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
... |
Additional arguments are ignored |
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_dataframe'
group_eval_j(x, i = NULL, j = NULL, ...)
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_grid'
group_eval_j(x, i = NULL, j = NULL, ...)
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_html'
group_eval_j(x, i = NULL, j = NULL, ihead = NULL, ...)
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_tabularray'
group_eval_j(x, i = NULL, j = NULL, ...)
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_tabulator'
group_eval_j(x, i = NULL, j = NULL, ...)
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_typst'
group_eval_j(x, i = NULL, j = NULL, indent = 0, ...)
Spanning labels to identify groups of rows or columns
Description
Spanning labels to identify groups of rows or columns
Alias for group_tt()
Usage
group_tt(
x,
i = getOption("tinytable_group_i", default = NULL),
j = getOption("tinytable_group_j", default = NULL),
...
)
tt_group(
x,
i = getOption("tinytable_group_i", default = NULL),
j = getOption("tinytable_group_j", default = NULL),
...
)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
i |
Character vector, named list, or integer vector
|
j |
String, named list, or character matrix
|
... |
Other arguments are ignored. |
Details
Warning: The style_tt()
can normally be used to style the group headers, as expected, but that feature is not available for Markdown and Word tables.
Value
An object of class tt
representing the table.
Markdown limitations
Markdown is a text-only format that only supports these styles: italic, bold, strikeout. The width
argument is also unavailable.
These limitations exist because there is no standard markdown syntax for the other styling options.
However, in terminals (consoles) that support it, tinytable
can display colors and text styles using
ANSI escape codes by setting theme_markdown(ansi = TRUE)
. This allows for rich formatting in
compatible terminal environments.
Word limitations
Word tables only support these styles: italic, bold, strikeout. The width
argument is also unavailable.
Moreover, the style_tt()
function cannot be used to style headers inserted by the group_tt()
function;
instead, you should style the headers directly in the header definition using markdown syntax:
group_tt(i = list("*italic header*" = 2))
. These limitations are due to the fact that we create
Word documents by converting a markdown table to .docx via the Pandoc software, which requires
going through a text-only intermediate format.
Examples
# vector of row labels
dat <- data.frame(
label = c("a", "a", "a", "b", "b", "c", "a", "a"),
x1 = rnorm(8),
x2 = rnorm(8)
)
tt(dat[, 2:3]) |> group_tt(i = dat$label)
# named lists of labels
tt(mtcars[1:10, 1:5]) |>
group_tt(
i = list(
"Hello" = 3,
"World" = 8
),
j = list(
"Foo" = 2:3,
"Bar" = 4:5
)
)
dat <- mtcars[1:9, 1:8]
tt(dat) |>
group_tt(i = list(
"I like (fake) hamburgers" = 3,
"She prefers halloumi" = 4,
"They love tofu" = 7
))
tt(dat) |>
group_tt(
j = list(
"Hamburgers" = 1:3,
"Halloumi" = 4:5,
"Tofu" = 7
)
)
x <- mtcars[1:5, 1:6]
tt(x) |>
group_tt(j = list("Hello" = 1:2, "World" = 3:4, "Hello" = 5:6)) |>
group_tt(j = list("Foo" = 1:3, "Bar" = 4:6))
# column names with delimiters
dat <- data.frame(
A_id = 1,
A_a1 = 2,
A_a2 = "3",
B_b1 = 4,
B_b2 = 5,
B_C = 6
)
tt(dat) |> group_tt(j = "_")
# matrix insertion
rowmat <- matrix(colnames(iris))
tt(head(iris, 7)) |>
group_tt(i = c(2, 5), j = rowmat)
rowmat <- matrix(c(
"a", "b", "c", "d", "e",
1, 2, 3, 4, 5))
tt(head(iris, 7)) |>
group_tt(i = 2, j = rowmat) |>
style_tt(i = "groupi", background = "pink")
Method for a tinytable S4 object
Description
Method for a tinytable S4 object
Usage
## S4 method for signature 'tinytable'
initialize(
.Object,
data = data.frame(),
caption = NULL,
notes = NULL,
theme = list("default"),
data_body = data.frame(),
placement = NULL,
width = NULL,
height = NULL,
colnames = TRUE
)
Arguments
caption |
A string that will be used as the caption of the table. This argument should not be used in Quarto or Rmarkdown documents. In that context, please use the appropriate chunk options. |
notes |
Notes to append to the bottom of the table. This argument accepts several different inputs:
|
theme |
Function or string.
|
width |
Table or column width.
|
height |
Row height in em units. Single numeric value greater than zero that determines the row height spacing. |
colnames |
|
Print a tinytable object in knitr
Description
Print a tinytable object in knitr
Usage
knit_print.tinytable(
x,
output = get_option("tinytable_print_output", default = NULL),
...
)
Value
A string with class knit_asis
to be printed in Rmarkdown or Quarto documents.
Method for a tinytable S4 object
Description
Method for a tinytable S4 object
Usage
## S4 replacement method for signature 'tinytable'
names(x) <- value
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
Method for a tinytable S4 object
Description
Method for a tinytable S4 object
Usage
## S4 method for signature 'tinytable'
names(x)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
Method for a tinytable S4 object
Description
Method for a tinytable S4 object
Usage
## S4 method for signature 'tinytable'
ncol(x)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
Method for a tinytable S4 object
Description
Method for a tinytable S4 object
Usage
## S4 method for signature 'tinytable'
nrow(x)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
Insert images and inline plots into tinytable objects
Description
The plot_tt()
function allows for the insertion of images and inline plots into
tinytable objects. This function can handle both local and web-based images.
Usage
plot_tt(
x,
i = NULL,
j = NULL,
fun = NULL,
data = NULL,
color = "black",
xlim = NULL,
height = 1,
height_plot = 400,
width_plot = 1200,
images = NULL,
sprintf = "%s",
assets = "tinytable_assets",
...
)
tt_plot(
x,
i = NULL,
j = NULL,
fun = NULL,
data = NULL,
color = "black",
xlim = NULL,
height = 1,
height_plot = 400,
width_plot = 1200,
images = NULL,
sprintf = "%s",
assets = "tinytable_assets",
...
)
Arguments
x |
A tinytable object. |
i |
Integer vector, the row indices where images are to be inserted. If |
j |
Integer vector, the column indices where images are to be inserted. If |
fun |
String or function to generate inline plots.
|
data |
a list of data frames or vectors to be used by the plotting functions in |
color |
string Name of color to use for inline plots (passed to the |
xlim |
Numeric vector of length 2. |
height |
Numeric, the height of the images in the table in em units. |
height_plot |
Numeric, the height of generated plot images in pixels (default: 400). |
width_plot |
Numeric, the width of generated plot images in pixels (default: 1200). |
images |
Character vector, the paths to the images to be inserted. Paths are relative to the main table file or Quarto (Rmarkdown) document. |
sprintf |
Character string, a sprintf format string to format the generated cell content. Default is "%s" which displays the content as-is. Use this to wrap images or plots in custom markup. |
assets |
Path to the directory where generated assets are stored. This path is relative to the location where a table is saved. |
... |
Extra arguments are passed to the function in |
Details
The plot_tt()
can insert images and inline plots into tables.
Value
A modified tinytable object with images or plots inserted.
Examples
## Not run:
# Built-in plot types
plot_data <- list(mtcars$mpg, mtcars$hp, mtcars$qsec)
dat <- data.frame(
Variables = c("mpg", "hp", "qsec"),
Histogram = "",
Density = "",
Bar = "",
BarPct = "",
Line = ""
)
# Random data for sparklines
lines <- lapply(1:3, \(x) data.frame(x = 1:10, y = rnorm(10)))
# Percentage data (values between 0 and 1)
pct_data <- list(0.65, 0.82, 0.41)
tt(dat) |>
plot_tt(j = 2, fun = "histogram", data = plot_data) |>
plot_tt(j = 3, fun = "density", data = plot_data, color = "darkgreen") |>
plot_tt(j = 4, fun = "bar", data = list(2, 3, 6), color = "orange") |>
plot_tt(j = 5, fun = "barpct", data = pct_data, color = "steelblue") |>
plot_tt(j = 6, fun = "line", data = lines, color = "blue") |>
style_tt(j = 2:6, align = "c")
# Custom function example (must have ... argument)
custom_hist <- function(d, ...) {
function() hist(d, axes = FALSE, ann = FALSE, col = "lightblue")
}
tt(data.frame(Variables = "mpg", Histogram = "")) |>
plot_tt(j = 2, fun = custom_hist, data = list(mtcars$mpg))
## End(Not run)
Create Plot Vector
Description
Create Plot Vector
Usage
plot_vector(
output = "html",
fun = NULL,
data = NULL,
color = "black",
xlim = NULL,
height = 1,
height_plot = 400,
width_plot = 1200,
images = NULL,
sprintf = "%s",
assets = "tinytable_assets",
...
)
Arguments
output |
Output format. One of "html", "latex", "typst", "markdown", etc. |
fun |
String or function to generate inline plots.
|
data |
a list of data frames or vectors to be used by the plotting functions in |
color |
string Name of color to use for inline plots (passed to the |
xlim |
Numeric vector of length 2. |
height |
Numeric, the height of the images in the table in em units. |
height_plot |
Numeric, the height of generated plot images in pixels (default: 400). |
width_plot |
Numeric, the width of generated plot images in pixels (default: 1200). |
images |
Character vector, the paths to the images to be inserted. Paths are relative to the main table file or Quarto (Rmarkdown) document. |
sprintf |
Character string, a sprintf format string to format the generated cell content. Default is "%s" which displays the content as-is. Use this to wrap images or plots in custom markup. |
assets |
Path to the directory where generated assets are stored. This path is relative to the location where a table is saved. |
... |
Extra arguments are passed to the function in |
Details
This function creates plots by creating a temporary tt()
object and applying plot_tt()
. It returns a character vector containing the image paths or HTML tags for the plots.
Value
A character vector with plot file paths or HTML tags.
Examples
## Not run:
# Create histogram plots
plot_data <- list(rnorm(100), rnorm(50))
plot_vector(fun = "histogram", data = plot_data, output = "html")
# Create density plots
plot_vector(fun = "density", data = plot_data, output = "latex")
# Create bar plots from single values
bar_data <- list(0.5, 0.8, 0.3)
plot_vector(fun = "barpct", data = bar_data, output = "html")
## End(Not run)
Print, display, or convert a tinytable object
Description
This function is called automatically by R
whenever a tinytable
object is anprinted to the console or in an HTML viewer pane.
Usage
## S3 method for class 'tinytable'
print(x, output = get_option("tinytable_print_output", default = NULL), ...)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
output |
format in which a Tiny Table is printed:
|
... |
Other arguments are ignored. |
Details
When printing to HTML in interactive()
mode, a temporary file is created and viewer()
is called to preview the file with the local browser (ex: Firefox or Chrome). The temporary file is then automatically cleaned up. On some operating systems, like some Linux distributions, browser do not have read access to the /tmp/
directory. In such cases, users can specify a custom location to store temporary HTML files. Note that this prevents tinytable
from automatically cleaning up temporary files automatically.
options(tinytable_tempdir = "/home/username/temp_directory")
Value
launch a browser window or cat() the table to console.
Combine tinytable
objects by rows (vertically)
Description
Combine tinytable
objects by rows (vertically)
Usage
## S4 method for signature 'tinytable,tinytable'
rbind2(x, y, use_names = TRUE, headers = TRUE, ...)
Arguments
x |
|
y |
|
use_names |
‘TRUE’ binds by matching column name, ‘FALSE’ by position |
headers |
Logical. TRUE inserts the colnames of |
... |
Additional arguments are ignored. |
Details
format_tt()
calls applied to x
or y
are evaluated before binding, to allow distinct formatting for each panel.
Calls to other tinytable
functions such as style_tt()
or group_tt()
are ignored when applied to x
or y
. These functions should be applied to the final table instead.
Information in these S4 slots is carried over from x
to the combined table:
-
x@output
-
x@caption
-
x@width
Information in these S4 slots is concatenated and carried over to the combined table:
-
c(x@notes, y@notes)
This function relies on the rbindlist()
function from the data.table
package.
Examples
library(tinytable)
x <- tt(mtcars[1:3, 1:2], caption = "Combine two tiny tables.")
y <- tt(mtcars[4:5, 8:10])
# rbind() does not support additional aarguments
# rbind2() supports additional arguments
# basic combination
rbind(x, y)
rbind(x, y) |> format_tt(replace = "")
# omit y header
rbind2(x, y, headers = FALSE)
# bind by position rather than column names
rbind2(x, y, use_names = FALSE)
Save a Tiny Table to File
Description
This function saves an object of class tinytable to a specified file and format, with an option to overwrite existing files.
Usage
save_tt(
x,
output = get_option("tinytable_save_output", default = NULL),
overwrite = get_option("tinytable_save_overwrite", default = FALSE)
)
tt_save(
x,
output = get_option("tinytable_save_output", default = NULL),
overwrite = get_option("tinytable_save_overwrite", default = FALSE)
)
Arguments
x |
The tinytable object to be saved. |
output |
String or file path.
|
overwrite |
A logical value indicating whether to overwrite an existing file. |
Value
A string with the table when output
is a format, and the file path when output
is a valid path.
Dependencies
-
.pdf
output requires a full LaTeX installation on the local computer. -
.png
output requires thewebshot2
package. -
.html
self-contained files require thebase64enc
package.
LaTeX preamble
tinytable
uses the tabularray
package from your LaTeX distribution to draw tables. tabularray
, in turn, uses the special tblr
, talltblr
, and longtblr
environments.
When rendering a document from Quarto or Rmarkdown directly to PDF, tinytable
will populate the LaTeX preamble automatically with all the required packages. For standalone LaTeX documents, these commands should be inserted in the preamble manually:
Note: Your document will fail to compile to PDF in Quarto if you enable caching and you use tinytable due to missing LaTeX headers. To avoid this problem, set the option #| cache: false
for the chunk(s) where you use tinytable.
\usepackage{tabularray} \usepackage{float} \usepackage{graphicx} \usepackage{rotating} \usepackage[normalem]{ulem} \UseTblrLibrary{siunitx} \newcommand{\tinytableTabularrayUnderline}[1]{\underline{#1}} \newcommand{\tinytableTabularrayStrikeout}[1]{\sout{#1}} \NewTableCommand{\tinytableDefineColor}[3]{\definecolor{#1}{#2}{#3}}
Global options
Options can be set with options()
and change the default behavior of tinytable. For example:
options(tinytable_tt_digits = 4) tt(head(iris))
You can set options in a script or via .Rprofile
. Note: be cautious with .Rprofile
settings as they may affect reproducibility.
Default values for function arguments
Nearly all of the package's functions retrieve their default values from global options. This allows you to set defaults once and apply them to all tables without needing to specify them each time. For example, to fix the the digits
argument of the tt()
function globally, call:
options(tinytable_tt_digits = 4)
In addition, some more specific options are available to control the behavior of the package in specific contexts.
-
tinytable_html_mathjax
: Insert MathJax scripts (warning: may conflict if MathJax is loaded elsewhere) -
tinytable_pdf_clean
: Delete temporary and log files for pdf output insave_tt()
-
tinytable_color_name_normalization
: Enable/disable automatic color name processing (default: TRUE). When enabled, R color names recognized bycol2rgb()
are converted to hex format for consistent rendering across HTML, LaTeX, and Typst formats. If R color conversion fails, LaTeX color names are used as fallback. Colors explicitly supplied as hex values with "#" prefix are passed through unchanged. Set to FALSE to disable processing and pass color names unchanged.
Quarto
The format_tt(quarto=TRUE)
argument enables Quarto data processing with some limitations:
The
\QuartoMarkdownBase64{}
LaTeX macro may not process references and markdown as expectedQuarto processing may conflict with
tinytable
styling/formatting
Options:
-
tinytable_quarto_disable_processing
: Disable Quarto cell processing
Example of Quarto-specific code in cells:
x <- data.frame(Math = "x^2^", Citation = "@Lovelace1842") fn <- function(z) sprintf("<span data-qmd='%s'></span>", z) tt(x) |> format_tt(i = 1, fn = fn)
For more details on Quarto table processing: https://quarto.org/docs/authoring/tables.html#disabling-quarto-table-processing
Examples
library(tinytable)
x <- mtcars[1:4, 1:5]
fn <- file.path(tempdir(), "test.html")
tt(x) |> save_tt(fn, overwrite = TRUE)
library(tinytable)
filename <- file.path(tempdir(), "table.tex")
tt(mtcars[1:4, 1:4]) |> save_tt(filename)
Apply style settings to a tinytable
Description
Apply style settings to a tinytable
Usage
style_eval(x, ...)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
... |
Additional arguments are ignored |
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_dataframe'
style_eval(x)
tinytable S4 method
Description
tinytable S4 method
Usage
## S4 method for signature 'tinytable_grid'
style_eval(x)
Style a Tiny Table
Description
Style a Tiny Table
Alias for style_tt()
Usage
style_tt(
x,
i = NULL,
j = NULL,
bold = FALSE,
italic = FALSE,
monospace = FALSE,
smallcap = FALSE,
underline = FALSE,
strikeout = FALSE,
color = NULL,
background = NULL,
fontsize = NULL,
align = NULL,
alignv = NULL,
colspan = NULL,
rowspan = NULL,
indent = NULL,
line = NULL,
line_color = "black",
line_width = 0.1,
line_trim = NULL,
finalize = NULL,
...
)
tt_style(
x,
i = NULL,
j = NULL,
bold = FALSE,
italic = FALSE,
monospace = FALSE,
smallcap = FALSE,
underline = FALSE,
strikeout = FALSE,
color = NULL,
background = NULL,
fontsize = NULL,
align = NULL,
alignv = NULL,
colspan = NULL,
rowspan = NULL,
indent = NULL,
line = NULL,
line_color = "black",
line_width = 0.1,
line_trim = NULL,
finalize = NULL,
...
)
Arguments
x |
A table object created by |
i |
Numeric vector, logical matrix, string, or unquoted expression.
|
j |
Column indices where the styling should be applied. Can be:
|
bold |
Logical; if |
italic |
Logical; if |
monospace |
Logical; if |
smallcap |
Logical; if |
underline |
Logical; if |
strikeout |
Logical; if |
color |
Text color. Colors are standardized across output formats and can be specified as:
|
background |
Background color. Same color specification options as the |
fontsize |
Font size in em units. Can be |
align |
A single character or a string with a number of characters equal to the number of columns in |
alignv |
A single character specifying vertical alignment. Valid characters include 't' (top), 'm' (middle), 'b' (bottom). |
colspan |
Number of columns a cell should span. |
rowspan |
Number of rows a cell should span. |
indent |
Text indentation in em units. Positive values only. |
line |
String determines if solid lines (rules or borders) should be drawn around the cell, row, or column.
|
line_color |
Color of the line. See the |
line_width |
Width of the line in em units (default: 0.1). |
line_trim |
String specifying line trimming. Acceptable values: "l" (left), "r" (right), "lr" (both sides). When specified, shortens the lines by 0.8pt on the specified side(s). Default: NULL (no trimming). |
finalize |
A function applied to the table object at the very end of table-building, for post-processing. For example, the function could use regular expressions to add LaTeX commands to the text version of the table hosted in |
... |
extra arguments are ignored |
Details
This function applies styling to a table created by tt()
. It allows customization of text style (bold, italic, monospace), text and background colors, font size, cell width, text alignment, column span, and indentation. The function also supports passing native instructions to LaTeX (tabularray) and HTML (bootstrap) formats.
Value
An object of class tt
representing the table.
Markdown limitations
Markdown is a text-only format that only supports these styles: italic, bold, strikeout. The width
argument is also unavailable.
These limitations exist because there is no standard markdown syntax for the other styling options.
However, in terminals (consoles) that support it, tinytable
can display colors and text styles using
ANSI escape codes by setting theme_markdown(ansi = TRUE)
. This allows for rich formatting in
compatible terminal environments.
Word limitations
Word tables only support these styles: italic, bold, strikeout. The width
argument is also unavailable.
Moreover, the style_tt()
function cannot be used to style headers inserted by the group_tt()
function;
instead, you should style the headers directly in the header definition using markdown syntax:
group_tt(i = list("*italic header*" = 2))
. These limitations are due to the fact that we create
Word documents by converting a markdown table to .docx via the Pandoc software, which requires
going through a text-only intermediate format.
Examples
if (knitr::is_html_output()) options(tinytable_print_output = "html")
library(tinytable)
tt(mtcars[1:5, 1:6])
# Alignment
tt(mtcars[1:5, 1:6]) |>
style_tt(j = 1:5, align = "lcccr")
# Colors and styles
tt(mtcars[1:5, 1:6]) |>
style_tt(i = 2:3, background = "black", color = "orange", bold = TRUE)
# column selection with `j``
tt(mtcars[1:5, 1:6]) |>
style_tt(j = 5:6, background = "pink")
tt(mtcars[1:5, 1:6]) |>
style_tt(j = "drat|wt", background = "pink")
tt(mtcars[1:5, 1:6]) |>
style_tt(j = c("drat", "wt"), background = "pink")
tt(mtcars[1:5, 1:6], theme = "empty") |>
style_tt(
i = 2, j = 2,
colspan = 3,
rowspan = 2,
align = "c",
alignv = "m",
color = "white",
background = "black",
bold = TRUE)
tt(mtcars[1:5, 1:6], theme = "empty") |>
style_tt(
i = 0:3,
j = 1:3,
line = "tblr",
line_width = 0.4,
line_color = "teal")
tt(mtcars[1:5, 1:6], theme = "striped") |>
style_tt(
i = c(2, 5),
j = 3,
strikeout = TRUE,
fontsize = 0.7)
# Non-standard evaluation (NSE)
dat <- data.frame(
w = c(143002.2092, 201399.181, 100188.3883),
x = c(1.43402, 201.399, 0.134588),
y = as.Date(c(897, 232, 198), origin = "1970-01-01"),
z = c(TRUE, TRUE, FALSE)
)
tt(dat) |>
style_tt(i = w > 150000, j = c("w", "x"),
color = "white", background = "black")
tt(mtcars[1:5, 1:6]) |>
theme_html(class = "table table-dark table-hover")
inner <- "
column{1-4}={halign=c},
hlines = {fg=white},
vlines = {fg=white},
cell{1,6}{odd} = {bg=teal7},
cell{1,6}{even} = {bg=green7},
cell{2,4}{1,4} = {bg=red7},
cell{3,5}{1,4} = {bg=purple7},
cell{2}{2} = {r=4,c=2}{bg=azure7},
"
tt(mtcars[1:5, 1:4], theme = "empty") |>
theme_latex(inner = inner)
# Style group rows and non-group rows
dat <- data.frame(x = 1:6, y = letters[1:6])
dat |>
tt() |>
group_tt(i = list("Group A" = 3)) |>
style_tt(i = "groupi", background = "lightblue") |>
style_tt(i = "~groupi", background = "lightgray")
# unquote expressions
dat <- mtcars[1:10,]
dat <- dat[order(dat$am),]
tt(dat) |>
subset(mpg > 20) |>
group_tt(am)
# style elements: captions and colnames
notes <- list(
"*" = "Hello world",
"a" = "Bacon ipsum dolor amet kevin t-bone porchetta.")
tt(head(iris),
width = .5,
caption = "This is a Caption Example.",
notes = notes) |>
style_tt(2, 2, background = "pink", rowspan = 2, colspan = 2,
alignv = "m", align = "c", line = "tblr") |>
style_tt("colnames", italic = TRUE) |>
style_tt("caption", smallcap = TRUE)
Style a Vector with Text Formatting
Description
Style a Vector with Text Formatting
Usage
style_vector(
x,
output = "html",
bold = FALSE,
italic = FALSE,
monospace = FALSE,
smallcap = FALSE,
underline = FALSE,
strikeout = FALSE,
color = NULL,
fontsize = NULL,
indent = NULL
)
Arguments
x |
A vector to be styled. |
output |
Output format for styling. One of "html", "latex", "typst", "markdown", "ansi". Defaults to "html". |
bold |
Logical; if |
italic |
Logical; if |
monospace |
Logical; if |
smallcap |
Logical; if |
underline |
Logical; if |
strikeout |
Logical; if |
color |
Text color. Must be of length 1 or
|
fontsize |
Font size in em units. Must be of length 1 or |
indent |
Text indentation in em units. Must be of length 1 or |
Details
This function applies styling to a vector. It allows customization of text style (bold, italic, monospace), text color, font size, and text decorations (underline, strikeout). The styling is applied element-wise to the vector. Vectors are coerced with as.character()
before styling.
Value
A character vector with applied styling.
Examples
# Basic styling
style_vector(c("Hello", "World"), bold = TRUE, color = "red")
# Different styles per element
style_vector(
c("Bold text", "Italic text", "Monospace"),
bold = c(TRUE, FALSE, FALSE),
italic = c(FALSE, TRUE, FALSE),
monospace = c(FALSE, FALSE, TRUE)
)
# Single style applied to all elements
style_vector(c("A", "B", "C"), color = "blue", fontsize = 1.2)
Subsetting a tinytable
object
Description
Return subsets tinytable
which meet conditions.
Usage
## S3 method for class 'tinytable'
subset(x, subset, select, drop = FALSE, ...)
Arguments
x |
object to be subsetted. |
subset |
logical expression indicating elements or rows to keep: missing values are taken as false. |
select |
expression, indicating columns to select from a data frame. |
drop |
passed on to |
... |
further arguments to be passed to or from other methods. |
Default theme for TinyTable
Description
Default theme for TinyTable
Usage
theme_default(x, ...)
Arguments
x |
A tinytable object. |
... |
Additional arguments are ignored. |
Value
A modified tinytable
object.
Theme for a void table
Description
This function calls styles and formatting applied to a tinytable
object up to that point in the pipeline.
Usage
theme_empty(x, ...)
Arguments
x |
A tinytable object. |
... |
Additional arguments are ignored. |
Grid theme with borders around all cells
Description
Grid theme with borders around all cells
Usage
theme_grid(x, ...)
Arguments
x |
A |
... |
Additional arguments (ignored). |
Value
A modified tinytable
object.
HTML-specific styles and options
Description
HTML-specific styles and options
Usage
theme_html(
x,
engine = get_option("tinytable_html_engine", default = NULL),
i = NULL,
j = NULL,
class = get_option("tinytable_html_class", default = NULL),
css = get_option("tinytable_html_css", default = NULL),
css_rule = get_option("tinytable_html_css_rule", default = NULL),
portable = get_option("tinytable_html_portable"),
tabulator_columns = get_option("tinytable_html_tabulator_columns"),
tabulator_css_rule = get_option("tinytable_html_tabulator_css_rule"),
tabulator_layout = get_option("tinytable_html_tabulator_layout", default =
"fitDataTable"),
tabulator_options = get_option("tinytable_html_tabulator_options"),
tabulator_pagination = get_option("tinytable_html_tabulator_pagination"),
tabulator_search = get_option("tinytable_html_tabulator_search"),
tabulator_stylesheet = get_option("tinytable_html_tabulator_stylesheet"),
...
)
Arguments
x |
A |
engine |
Character string specifying the HTML engine: "tinytable", "bootstrap", or "tabulator". |
i |
Row indices. |
j |
Column indices. |
class |
String. HTML table class. |
css |
Character vector. CSS style declarations. |
css_rule |
String. Complete CSS rules. |
portable |
Logical. Sets whether to create portable HTML output with embedded Javascript, CSS, and base64-encoded images. |
tabulator_columns |
Custom column definitions. |
tabulator_css_rule |
Complete CSS rules. |
tabulator_layout |
Character string. Table layout algorithm for column sizing. Default is "fitDataTable". Available options: "fitDataTable", "fitData", "fitDataFill", "fitDataStretch", "fitColumns". |
tabulator_options |
Custom Tabulator.js configuration options. |
tabulator_pagination |
Logical or numeric vector. Pagination settings for large tables.
|
tabulator_search |
Character or NULL. Search functionality position.
|
tabulator_stylesheet |
Character string. CSS stylesheet theme for Tabulator.js tables. Default is "bootstrap5". Available options: "default", "simple", "midnight", "modern", "site", "site_dark", "bootstrap3", "bootstrap4", "bootstrap5", "semanticui", "bulma", "materialize", or a custom HTTP URL starting with "http". |
... |
Additional arguments are ignored. |
LaTeX-Specific Theme for tinytable
Description
This function provides comprehensive LaTeX-specific theming and configuration options
for tinytable
objects. It allows customization of LaTeX environments, table layout,
multipage behavior, resizing, and placement within LaTeX documents.
Usage
theme_latex(
x,
inner = NULL,
outer = NULL,
environment = get_option("tinytable_latex_environment", default = NULL),
environment_table = get_option("tinytable_latex_environment_table", default = TRUE),
multipage = get_option("tinytable_latex_multipage", default = FALSE),
rowhead = get_option("tinytable_latex_rowhead", 0L),
rowfoot = get_option("tinytable_latex_rowfoot", 0L),
resize_width = get_option("tinytable_latex_resize_width", 1),
resize_direction = get_option("tinytable_latex_resize_direction", default = NULL),
placement = get_option("tinytable_latex_placement", NULL),
preamble = NULL,
engine = NULL,
...
)
Arguments
x |
A |
inner |
Character string specifying inner tabularray options. These options
control the internal formatting of the table (e.g., column alignment, spacing).
Will be added to any existing inner options. Default is |
outer |
Character string specifying outer tabularray options. These options
control the external formatting around the table. Will be added to any existing
outer options. Default is |
environment |
Character string specifying the LaTeX table environment to use. Options are:
Default is controlled by |
environment_table |
Logical indicating whether to wrap the table in a |
multipage |
Logical indicating whether to enable multipage table functionality.
When |
rowhead |
Integer specifying the number of header rows to repeat on each page
in multipage tables. Only valid with |
rowfoot |
Integer specifying the number of footer rows to repeat on each page
in multipage tables. Only valid with |
resize_width |
Numeric value between 0.01 and 1.0 specifying the target width
as a fraction of |
resize_direction |
Character string specifying how to resize tables that are too wide or too narrow. Options are:
Default is controlled by |
placement |
Character string specifying LaTeX float placement options for the
table environment (e.g., "h", "t", "b", "p", "H"). Only used when |
preamble |
Logical value specifying whether to include LaTeX preamble packages. If not NULL, overrides the table's preamble setting. |
engine |
Character string specifying the LaTeX engine to use for PDF compilation. Options are "xelatex", "pdflatex", or "lualatex". If not NULL, overrides the table's engine setting. |
... |
Additional arguments (currently unused). |
Details
The function provides fine-grained control over LaTeX table output through several mechanisms:
Environment Selection: Different LaTeX environments offer different capabilities:
-
tblr
: Modern tabularray syntax with full styling support -
talltblr
: Liketblr
but optimized for tall tables -
longtblr
: Supports page breaks and repeated headers/footers -
tabular
: Basic LaTeX syntax, limited styling but maximum compatibility
Multipage Tables:
When multipage = TRUE
or when rowhead
/rowfoot
are specified, the function
automatically switches to longtblr
environment and disables the table wrapper.
This allows tables to break across pages while maintaining headers and footers.
Resizing:
The resize functionality uses LaTeX's \\resizebox
command to automatically
adjust table width based on content and page constraints. This is particularly
useful for tables with many columns.
Tabularray Options: Inner and outer options directly control tabularray formatting. Inner options affect cell content and spacing, while outer options control the table's relationship with surrounding text.
Value
A modified tinytable
object with LaTeX-specific theming applied.
See Also
Markdown theme with optional ANSI color support and grid customization
Description
Markdown theme with optional ANSI color support and grid customization
Usage
theme_markdown(
x,
ansi = FALSE,
style = NULL,
vline = NULL,
hline = NULL,
hline_header = NULL,
...
)
Arguments
x |
A |
ansi |
Logical. If TRUE, enables ANSI color codes for grid styling. Default is FALSE. |
style |
Character. Markdown style format. Can be "grid" or "gfm". Default is NULL. |
vline |
Logical. Enable/disable vertical lines. Default is TRUE. |
hline |
Logical. Enable/disable horizontal lines. Default is TRUE. |
hline_header |
Logical. Enable/disable the special header separator line below column names. Default is TRUE. |
... |
Additional arguments (ignored). |
Details
When ansi = TRUE
, colors and text styling (bold, italic, strikeout, underline)
are applied using ANSI escape sequences for terminal display. ANSI colors require
a terminal or application that supports ANSI escape sequences. Common supported
terminals include: Terminal.app (macOS), iTerm2 (macOS), Windows Terminal, most
Linux terminals, RStudio Console, and VS Code terminal. Colors may not display
correctly in basic text editors or older terminals.
Value
A modified tinytable
object.
RevealJS presentation theme
Description
RevealJS presentation theme
Usage
theme_revealjs(
x,
css = get_option("tinytable_revealjs_css", default = "light"),
fontsize = get_option("tinytable_revealjs_fontsize", default = 0.8),
fontsize_caption = get_option("tinytable_revealjs_fontsize_caption", default = 1)
)
Arguments
x |
A |
css |
String. CSS theme: "light" (default) or "dark". |
fontsize |
Numeric. Font size multiplier for table content. |
fontsize_caption |
Numeric. Font size multiplier for table captions. |
Value
A modified tinytable
object.
Rotate table theme (LaTeX and Typst only)
Description
Rotate table theme (LaTeX and Typst only)
Usage
theme_rotate(
x,
angle = get_option("tinytable_rotate_angle", default = 90),
...
)
Arguments
x |
A |
angle |
Numeric. Rotation angle in degrees (0-360). |
... |
Additional arguments (ignored). |
Value
A modified tinytable
object.
Striped theme with alternating row colors
Description
Striped theme with alternating row colors
Usage
theme_striped(x, ...)
Arguments
x |
A |
... |
Additional arguments (ignored). |
Value
A modified tinytable
object.
Deprecated: Use format-specific theme functions instead
Description
DEPRECATED: The theme_tt()
function has been deprecated. Please use the format-specific or style-specific theme functions instead.
Usage
theme_tt(x, theme, ...)
Arguments
x |
deprecated |
theme |
deprecated |
... |
Additional arguments |
Value
Throws an informative error message
Typst-specific styles and options
Description
Typst-specific styles and options
Usage
theme_typst(
x,
figure = get_option("tinytable_typst_figure", default = TRUE),
align_figure = get_option("tinytable_typst_align_figure", NULL),
...
)
Arguments
x |
A |
figure |
Logical, whether to wrap the table in a Typst figure environment and block. |
align_figure |
Character string indicating horizontal alignment: "l", "c", or "r".
Defaults to |
... |
Additional arguments. |
tinytable S4 class
Description
tinytable S4 class
Draw a Tiny Table
Description
The tt
function renders a table in different formats with various styling options: HTML, Markdown, LaTeX, Word, PDF, PNG, or Typst. The table can be customized with additional functions:
-
style_tt()
: style fonts, colors, alignment, etc. -
format_tt()
: format numbers, dates, strings, etc. -
group_tt()
: row or column group labels. -
save_tt()
: save the table to a file or return the table as a string. -
print()
: print to a specific format, ex:print(x, "latex")
-
theme_*()
functions apply a collection of format-specific or visual transformations to atinytable.
tinytable
attempts to determine the appropriate way to print the table based on interactive use, RStudio availability, and output format in RMarkdown or Quarto documents. Users can call print(x, output="markdown")
to print the table in a specific format. Alternatively, they can set a global option: options("tinytable_print_output"="markdown")
Usage
tt(x, ...)
## Default S3 method:
tt(
x,
digits = get_option("tinytable_tt_digits", default = NULL),
caption = get_option("tinytable_tt_caption", default = NULL),
notes = get_option("tinytable_tt_notes", default = NULL),
width = get_option("tinytable_tt_width", default = NULL),
height = get_option("tinytable_tt_height", default = NULL),
theme = get_option("tinytable_tt_theme", default = "default"),
colnames = get_option("tinytable_tt_colnames", default = TRUE),
rownames = get_option("tinytable_tt_rownames", default = FALSE),
escape = get_option("tinytable_tt_escape", default = FALSE),
...
)
Arguments
x |
A data frame, data table, or tibble to be rendered as a table. |
... |
Additional arguments are ignored |
digits |
Number of significant digits to keep for numeric variables. When |
caption |
A string that will be used as the caption of the table. This argument should not be used in Quarto or Rmarkdown documents. In that context, please use the appropriate chunk options. |
notes |
Notes to append to the bottom of the table. This argument accepts several different inputs:
|
width |
Table or column width.
|
height |
Row height in em units. Single numeric value greater than zero that determines the row height spacing. |
theme |
Function or string.
|
colnames |
|
rownames |
Logical. If |
escape |
Logical. If |
Value
An object of class tt
representing the table.
The table object has S4 slots which hold information about the structure of the table. For example, the table@group_index_i
slot includes the row indices for grouping labels added by group_tt()
.
Warning: Relying on or modifying the contents of these slots is strongly discouraged. Their names and contents could change at any time, and the tinytable
developers do not consider changes to the internal structure of the output object to be a "breaking change" for versioning or changelog purposes.
Dependencies
-
.pdf
output requires a full LaTeX installation on the local computer. -
.png
output requires thewebshot2
package. -
.html
self-contained files require thebase64enc
package.
LaTeX preamble
tinytable
uses the tabularray
package from your LaTeX distribution to draw tables. tabularray
, in turn, uses the special tblr
, talltblr
, and longtblr
environments.
When rendering a document from Quarto or Rmarkdown directly to PDF, tinytable
will populate the LaTeX preamble automatically with all the required packages. For standalone LaTeX documents, these commands should be inserted in the preamble manually:
Note: Your document will fail to compile to PDF in Quarto if you enable caching and you use tinytable due to missing LaTeX headers. To avoid this problem, set the option #| cache: false
for the chunk(s) where you use tinytable.
\usepackage{tabularray} \usepackage{float} \usepackage{graphicx} \usepackage{rotating} \usepackage[normalem]{ulem} \UseTblrLibrary{siunitx} \newcommand{\tinytableTabularrayUnderline}[1]{\underline{#1}} \newcommand{\tinytableTabularrayStrikeout}[1]{\sout{#1}} \NewTableCommand{\tinytableDefineColor}[3]{\definecolor{#1}{#2}{#3}}
Markdown limitations
Markdown is a text-only format that only supports these styles: italic, bold, strikeout. The width
argument is also unavailable.
These limitations exist because there is no standard markdown syntax for the other styling options.
However, in terminals (consoles) that support it, tinytable
can display colors and text styles using
ANSI escape codes by setting theme_markdown(ansi = TRUE)
. This allows for rich formatting in
compatible terminal environments.
Word limitations
Word tables only support these styles: italic, bold, strikeout. The width
argument is also unavailable.
Moreover, the style_tt()
function cannot be used to style headers inserted by the group_tt()
function;
instead, you should style the headers directly in the header definition using markdown syntax:
group_tt(i = list("*italic header*" = 2))
. These limitations are due to the fact that we create
Word documents by converting a markdown table to .docx via the Pandoc software, which requires
going through a text-only intermediate format.
Tabulator (interactive tables)
Experimental Feature: The Tabulator.js integration is experimental and the API may change in future versions.
The Tabulator.js library provides powerful interactive table features including sorting, filtering, pagination, data export, and real-time editing capabilities. This theme customizes the appearance and behavior of Tabulator tables.
Features:
Sorting and filtering of all columns
Pagination with configurable page sizes
Search functionality across all columns
Multiple CSS themes and custom styling
Real-time data export options
Accessibility features (ARIA compliant)
Limitations:
Limited
style_tt()
support (onlyalign
andalignv
)Row-based formatting (
format_tt()
withi
argument) not supportedGlobal stylesheets affect all tables in multi-table documents
Date formatting uses Luxon tokens, not R's
strptime
formatBoolean formatting requires
format_tt()
withbool
argument for custom display
Global options
Options can be set with options()
and change the default behavior of tinytable. For example:
options(tinytable_tt_digits = 4) tt(head(iris))
You can set options in a script or via .Rprofile
. Note: be cautious with .Rprofile
settings as they may affect reproducibility.
Default values for function arguments
Nearly all of the package's functions retrieve their default values from global options. This allows you to set defaults once and apply them to all tables without needing to specify them each time. For example, to fix the the digits
argument of the tt()
function globally, call:
options(tinytable_tt_digits = 4)
In addition, some more specific options are available to control the behavior of the package in specific contexts.
-
tinytable_html_mathjax
: Insert MathJax scripts (warning: may conflict if MathJax is loaded elsewhere) -
tinytable_pdf_clean
: Delete temporary and log files for pdf output insave_tt()
-
tinytable_color_name_normalization
: Enable/disable automatic color name processing (default: TRUE). When enabled, R color names recognized bycol2rgb()
are converted to hex format for consistent rendering across HTML, LaTeX, and Typst formats. If R color conversion fails, LaTeX color names are used as fallback. Colors explicitly supplied as hex values with "#" prefix are passed through unchanged. Set to FALSE to disable processing and pass color names unchanged.
Quarto
The format_tt(quarto=TRUE)
argument enables Quarto data processing with some limitations:
The
\QuartoMarkdownBase64{}
LaTeX macro may not process references and markdown as expectedQuarto processing may conflict with
tinytable
styling/formatting
Options:
-
tinytable_quarto_disable_processing
: Disable Quarto cell processing
Example of Quarto-specific code in cells:
x <- data.frame(Math = "x^2^", Citation = "@Lovelace1842") fn <- function(z) sprintf("<span data-qmd='%s'></span>", z) tt(x) |> format_tt(i = 1, fn = fn)
For more details on Quarto table processing: https://quarto.org/docs/authoring/tables.html#disabling-quarto-table-processing
Order of Operations
When building tables, tinytable applies operations in this specific order:
-
format_tt()
: Number and string formatting operations are applied first to ensure all data is properly formatted before any other operations. -
group_tt()
: Row and column grouping operations are applied to insert group headers and modify table structure. -
theme
argument intt()
: The theme specified in the theme argument is applied immediately when creating the table object. -
theme_*()
with delayed execution viabuild_prepare()
: Theme functions that need to be applied after the table structure is finalized (such as those that depend on final row/column indices) are executed at this stage. Examples includetheme_default()
which applies default borders after groups are inserted. Internally,build_prepare()
allows callingstyle_tt()
with full knowledge of the output format and access to internal slots likex@output
. -
style_tt()
andtheme_*()
with immediate execution: Direct styling calls and theme functions without delayed execution are applied in the order they appear in the code. -
theme_*()
with delayed execution viabuild_finalize()
: Final theme operations that need to modify the rendered table string are applied last. Examples includetheme_rotate()
which wraps the entire table output. Internally,build_finalize()
allows post-processing the rendered table in text format using regular expressions and string manipulations.
This order ensures that structural changes (grouping) happen before styling, and that operations requiring the final table structure are deferred appropriately. When conflicts arise between operations at the same level, "last applied wins" - the most recent operation takes precedence.
Examples
library(tinytable)
x <- mtcars[1:4, 1:5]
tt(x)
tt(x,
theme = "striped",
width = 0.5,
caption = "Data about cars."
)
tt(x, notes = "Hello World!")
fn <- list(i = 0:1, j = 2, text = "Hello World!")
tab <- tt(x, notes = list("*" = fn))
print(tab, "latex")
k <- data.frame(x = c(0.000123456789, 12.4356789))
tt(k, digits = 2)
# use variable labels stored in attributes as column names
dat = mtcars[1:5, c("cyl", "mpg", "hp")]
attr(dat$cyl, "label") <- "Cylinders"
attr(dat$mpg, "label") <- "Miles per Gallon"
attr(dat$hp, "label") <- "Horse Power"
tt(dat, colnames = "label")