huxtable (version 4.7.1)

caption: Caption

Description

Functions to get or set the table-level caption property of a huxtable.

Usage

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

Arguments

ht

A huxtable.

value

A length-one character vector. Set to NA to reset to the default, which is NA.

Value

For caption, the caption property. For set_caption, the modified huxtable.

Details

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

See Also

caption_pos()

Examples

# NOT RUN {
orig <- caption(jams)
caption(jams) <-  "An example table"
caption(jams)
jams
caption(jams) <- orig

# escape caption characters:
caption(jams) <- sanitize(
      "Make $$$ with jam",
      type = "latex")
# }