label: Set a table label for external referencing

Description Usage Arguments Details Value See Also Examples

Description

The label is used as the table's label in LaTeX, and as the "id" property of the table element in HTML.

Usage

1
2
3
label(ht)
label(ht) <- value
set_label(ht, value)

Arguments

ht

A huxtable.

value

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

Details

LaTeX table labels typically start with "tab:".

Within knitr, huxtable labels will default to the same as the knitr chunk label. To turn off this behaviour, set options(huxtable.autolabel = FALSE).

If you use bookdown, and set a label on your table, the table caption() will automatically be prefixed with (#label). You can then refer to the table using @ref(label). label needs to start with "tab:"; if it doesn't, the "tab:" prefix will be added automatically. To turn off this behaviour, set options(huxtable.bookdown = FALSE).

Value

label() returns the label property. set_label() returns the modified huxtable.

See Also

huxtable-options

Examples

1
2
label(jams) <-  "tab:mytable"
label(jams)

huxtable documentation built on May 15, 2021, 1:09 a.m.