Title:	Better 'Typst' Tables
Version:	0.1.0
URL:	https://freierson.github.io/typstable/, https://github.com/freierson/typstable
BugReports:	https://github.com/freierson/typstable/issues
Description:	Create 'Typst' table markup from data frames. Features a pipe-friendly interface for column, row, and cell styling with support for grouped headers, grouped rows, and data-driven formatting.
Depends:	R (≥ 4.1.0)
Encoding:	UTF-8
RoxygenNote:	7.3.3
Imports:	rlang (≥ 1.0.0), tidyselect
Suggests:	testthat (≥ 3.0.0), knitr, rmarkdown, tibble, dplyr
VignetteBuilder:	knitr
Config/testthat/edition:	3
License:	GPL-3
Date:	2026-01-26
NeedsCompilation:	no
Packaged:	2026-02-11 23:27:54 UTC; filip
Author:	Filip Reierson [aut, cre]
Maintainer:	Filip Reierson <filip.reierson@gmail.com>
Repository:	CRAN
Date/Publication:	2026-02-16 17:30:02 UTC

Knit print method for typst_table

Description

Renders a typst_table for use in Quarto/knitr documents with Typst output.

Usage

knit_print.typst_table(x, ...)

Arguments

Value

A knitr::asis_output object containing the Typst markup.

Print a typst_table object

Description

Prints the Typst markup for a table to the console.

Usage

## S3 method for class 'typst_table'
print(x, ...)

Arguments

Value

Invisibly returns the Typst code as a character string.

Create a Typst table

Description

Creates a typst_table object from a data.frame or tibble that can be rendered to Typst markup. Use pipe-friendly styling functions like tt_style(), tt_column(), tt_row(), and tt_cell() to customize the table appearance.

Usage

tt(
  data,
  cols = tidyselect::everything(),
  col_names = NULL,
  col_widths = "auto",
  align = NULL,
  preamble = NULL,
  escape = TRUE,
  rownames = TRUE
)

Arguments

Value

A typst_table object that can be further styled and rendered.

Examples

# Basic table (includes row names by default)
tt(mtcars[1:5, 1:3])

# Select specific columns (excludes row names)
tt(mtcars, cols = c(mpg, cyl, hp), rownames = FALSE)

# Custom column names
tt(mtcars[1:5, 1:3], col_names = c("Miles/Gallon", "Cylinders", "Horsepower"), rownames = FALSE)

# Right-align numeric columns
tt(mtcars[1:5, 1:3], align = "right")

Style specific cells

Description

Applies formatting to individual cells. Allows for precise control over cell appearance including spanning multiple rows or columns.

Usage

tt_cell(
  table,
  row,
  column,
  bold = NULL,
  italic = NULL,
  color = NULL,
  fill = NULL,
  align = NULL,
  font_size = NULL,
  rotate = NULL,
  inset = NULL,
  stroke = NULL,
  colspan = 1,
  rowspan = 1,
  content = NULL
)

Arguments

Value

The modified typst_table object.

Examples

# Highlight a specific cell
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_cell(1, 1, fill = "yellow", bold = TRUE)

# Cell spanning multiple columns
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_cell(1, 1, colspan = 2, content = "Combined")

Style specific columns

Description

Applies formatting to one or more columns. Supports both static values and data-driven formatting where styling parameters reference other columns.

Usage

tt_column(
  table,
  column,
  width = NULL,
  align = NULL,
  bold = NULL,
  italic = NULL,
  color = NULL,
  fill = NULL,
  border_left = NULL,
  border_right = NULL,
  font_size = NULL,
  rotate = NULL,
  inset = NULL,
  stroke = NULL,
  .missing = c("warn", "ignore", "error")
)

Arguments

Details

Data-driven formatting

Style parameters can reference columns in the original data for per-row values:

data |>
  mutate(bg_color = ifelse(value > 100, "red", "white")) |>
  tt(cols = c(name, value)) |>
  tt_column(value, fill = bg_color)

The bg_color column is hidden from display but used for styling.

Pattern-based styling

When styling multiple columns with a naming convention, use {col} patterns to automatically expand column references:

# Instead of repetitive calls:
data |>
  tt(cols = c(mpg, qsec)) |>
  tt_column(everything(), color = "color_{col}", fill = "bg_{col}")

For column mpg, this looks for color_mpg and bg_mpg in the data.

Value

The modified typst_table object.

Examples

# Right-align and bold a numeric column
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_column(mpg, align = "right", bold = TRUE)

# Style multiple columns at once
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_column(c(mpg, disp), align = "right", color = "blue")

# Pattern-based styling (column-specific style columns)
df <- data.frame(
  a = 1:3, b = 4:6,
  color_a = c("red", "green", "blue"),
  color_b = c("black", "gray", "white")
)
tt(df, cols = c(a, b), rownames = FALSE) |>
  tt_column(c(a, b), color = "color_{col}")

Add grouped header row above column names

Description

Adds a spanning header row above the existing column names to group related columns together.

Usage

tt_header_above(
  table,
  header,
  bold = TRUE,
  align = "center",
  color = NULL,
  fill = NULL,
  italic = NULL,
  font_size = NULL,
  rotate = NULL,
  inset = NULL,
  stroke = NULL,
  line = TRUE,
  gap = "10pt"
)

Arguments

Value

The modified typst_table object.

Examples

# Group columns under headers
tt(mtcars[1:5, 1:6], rownames = FALSE) |>
  tt_header_above(c("Performance" = 3, "Design" = 3))

# Leave some columns ungrouped
tt(mtcars[1:5, 1:6], rownames = FALSE) |>
  tt_header_above(c(" " = 1, "Group A" = 2, "Group B" = 3))

# Disable gaps between groups
tt(mtcars[1:5, 1:6], rownames = FALSE) |>
  tt_header_above(c(" " = 1, "Group A" = 2, "Group B" = 3), gap = NULL)

Add horizontal line to table

Description

Adds a horizontal line at a specific position in the table.

Usage

tt_hline(table, y, start = NULL, end = NULL, stroke = TRUE)

Arguments

Value

The modified typst_table object.

Examples

# Add line below header
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_hline(1)

# Add colored line
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_hline(1, stroke = "blue")

# Partial line spanning some columns
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_hline(1, start = 0, end = 2)

Group rows under a label

Description

Inserts a group label row and optionally indents the grouped rows. Useful for creating visual sections in the table.

Usage

tt_pack_rows(
  table,
  group_label = NULL,
  start_row = NULL,
  end_row = NULL,
  index = NULL,
  indent = TRUE,
  bold_label = TRUE
)

Arguments

Value

The modified typst_table object.

Examples

# Group rows with a label
tt(mtcars[1:10, 1:3], rownames = FALSE) |>
  tt_pack_rows("4 Cylinders", 1, 5) |>
  tt_pack_rows("6 Cylinders", 6, 10)

# Using index parameter (alternative style)
tt(mtcars[1:10, 1:3], rownames = FALSE) |>
  tt_pack_rows(index = c("4 Cylinders" = 5, "6 Cylinders" = 5))

Render a typst_table to Typst markup

Description

Generates Typst code from a typst_table object. This is called automatically by print() and knit_print(), but can also be called directly.

Usage

tt_render(table)

Arguments

Value

A character string containing Typst table markup.

Examples

code <- tt(mtcars[1:3, 1:3], rownames = FALSE) |> tt_render()
cat(code)

Style specific rows

Description

Applies formatting to one or more rows. Use row = 0 to style the header row.

Usage

tt_row(
  table,
  row,
  bold = NULL,
  italic = NULL,
  color = NULL,
  fill = NULL,
  align = NULL,
  font_size = NULL,
  rotate = NULL,
  inset = NULL,
  stroke = NULL,
  hline_above = NULL,
  hline_below = NULL
)

Arguments

Value

The modified typst_table object.

Examples

# Style header row
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_row(0, bold = TRUE, fill = "gray")

# Highlight specific rows
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_row(c(1, 3, 5), fill = "#ffffcc")

# Add horizontal lines
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_row(3, hline_above = TRUE, hline_below = TRUE)

Save a typst_table to SVG, PNG, PDF, or Typst source

Description

Exports a typst_table object to various output formats. For SVG, PNG, and PDF output, the Typst CLI must be installed and available on the system PATH.

Usage

tt_save(
  table,
  file,
  width = "auto",
  height = "auto",
  margin = "0.5em",
  ppi = 144,
  typst_path = NULL,
  overwrite = TRUE
)

Arguments

Details

For .typ output, only the Typst source code is written and the Typst CLI is not required.

For .svg, .png, and .pdf output, the function: 1

1. Generates a complete Typst document with appropriate page settings

2. Writes it to a temporary .typ file

3. Calls ⁠typst compile⁠ to render the output

4. Cleans up the temporary file

The width and height parameters control the page size. Using "auto" for both (the default for both (the default) creates a page that fits the table content exactly.

Value

Invisibly returns the output file path.

Examples

# Save Typst source (no CLI required)
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_save(file.path(tempdir(), "table.typ"))

if (tt_typst_available()) {
  # Save as SVG
  tt(mtcars[1:5, 1:3], rownames = FALSE) |>
    tt_save(file.path(tempdir(), "table.svg"))

  # Save as PNG with higher resolution
  tt(mtcars[1:5, 1:3], rownames = FALSE) |>
    tt_save(file.path(tempdir(), "table.png"), ppi = 300)

  # Save as PDF with specific page size
  tt(mtcars[1:5, 1:3], rownames = FALSE) |>
    tt_style(stroke = TRUE) |>
    tt_save(file.path(tempdir(), "table.pdf"), width = "6in", height = "4in")
}

Style overall table appearance

Description

Sets global styling properties for the entire table including stroke (borders), fill, striped rows, and spacing.

Usage

tt_style(
  table,
  stroke = NULL,
  fill = NULL,
  striped = NULL,
  inset = NULL,
  row_gutter = NULL,
  column_gutter = NULL,
  position = NULL,
  full_width = FALSE
)

Arguments

Value

The modified typst_table object.

Examples

# Add borders and striped rows
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_style(stroke = TRUE, striped = TRUE)

# Custom border color and padding
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_style(stroke = "gray", inset = "8pt")

Check if Typst CLI is available

Description

Tests whether the Typst command-line interface is installed and accessible.

Usage

tt_typst_available(typst_path = NULL)

Arguments

Value

TRUE if Typst is available, FALSE otherwise.

Examples

# Check if Typst is installed
if (tt_typst_available()) {
  message("Typst is available")
} else {
  message("Typst not found - install from https://typst.app/")
}

Add vertical line to table

Description

Adds a vertical line at a specific position in the table.

Usage

tt_vline(table, x, start = NULL, end = NULL, stroke = TRUE)

Arguments

Value

The modified typst_table object.

Examples

# Add line after first column
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_vline(1)

# Add partial vertical line (data rows only)
tt(mtcars[1:5, 1:3], rownames = FALSE) |>
  tt_vline(1, start = 1)

Set proportional column widths

Description

Sets column widths as proportions that fill the page or container width. Widths are converted to Typst fr (fractional) units.

Usage

tt_widths(table, ...)

Arguments

Details

Widths are relative proportions, not absolute values. For example, tt_widths(tbl, 1, 2, 1) creates columns at 25%, 50%, 25% of the container width.

Value

The modified typst_table object.

Examples

# Equal widths
tt(mtcars[1:5, 1:3], rownames = FALSE) |> tt_widths(1, 1, 1)

# Proportional widths (25%, 50%, 25%)
tt(mtcars[1:5, 1:3], rownames = FALSE) |> tt_widths(1, 2, 1)

# Named columns
tt(mtcars[1:5, 1:3], rownames = FALSE) |> tt_widths(mpg = 1, cyl = 2, disp = 1)