caption: Set the table caption

In huxtable: Easily Create and Style Tables for LaTeX, HTML and Other Formats

Set the table caption

Description

By default, captions are displayed above the table. You can change this with caption_pos().

Usage

caption(ht)
caption(ht) <- value
set_caption(ht, value)

Arguments

ht	A huxtable.
value	A string. Set to NA to reset to the default, which is "NA".

Details

Captions are not escaped. See the example for a workaround.

Value

caption() returns the caption property. set_caption() returns the modified huxtable.

See Also

Other caption properties: caption_pos(), caption_width()

Examples

set_caption(jams, "Pots of jam for sale")
# escape caption characters:
caption(jams) <- sanitize(
      "Make $$$ with jam",
      type = "latex")

huxtable documentation built on April 3, 2025, 8:46 p.m.