Skip to contents

Render a data.frame as a raw Typst table, with optional repeating topic headers

Source: R/typst_topic_table.R
render_typst_table.Rd

Emits a fenced {=typst} block (which Quarto passes through verbatim) containing a #table(...) whose column header repeats (table.header(repeat: true, ...)) on every page the table continues onto. A rule (table.hline()) closes the column header, so it repeats with it under the header on every page, and another ends the table: the rules frame the data. When topic_cols is non-empty, each distinct combination of topic values is additionally emitted once, as its own repeating header row (table.header(level = 2, ...) for the first topic column, level = 3 for the second, and so on) spanning the data columns, immediately above its rows; x must already be sorted by topic_cols (new_tab_tibble() checks this). A topic header is never left alone at the bottom of a page – Typst keeps a table.header row with at least the row after it, verified against a render long enough to force the break. Without topic_cols, this is an ordinary repeating-header table.

Usage

render_typst_table(x, topic_cols = character(0), ...)

Arguments

x

A data.frame.

topic_cols

Character vector of column names (outer to inner) to group into repeating topic headers, or character(0) (the default) for an ordinary table.

...

Unused; present for interface consistency with the other backends.

Value

NULL, invisibly; called for the side effect of writing the rendered table with cat().

Details

Attributes of x adjust the table:

  • "tabtibble_align": the column alignment; see resolve_typst_align().

  • "tabtibble_widths": the column widths; see resolve_typst_widths().

  • "tabtibble_header_cols": the number of leading data columns that label their rows; a vertical rule (table.vline()) separates them from the other columns.

  • "tabtibble_topic_labels": TRUE to show each topic header as ": " instead of the value alone, so a topic row says what it is.

  • "tabtibble_typst_raw": the names of data columns whose cells are already Typst markup (for example $r^2$); they are written as given, not escaped, so the caller escapes any literal text in them. The other backends do not read these attributes, so under them (and under the markdown fallback outside Quarto) a raw column is escaped like any other and its markup shows literally.

Column names, in the column header and in topic headers, are escaped like cell text.