huxtable (version 6.0.2)

note_symbol: Set the symbols used for cell note references

Description

note_symbol is a table property controlling marks for cell_note(). The marks themselves are assigned when a huxtable is rendered rather than stored in its cells, so subsetting does not modify cell-note metadata.

Usage

note_symbol(ht)
note_symbol(ht) <- value
set_note_symbol(ht, value)

Value

note_symbol() returns a character string. The replacement function and set_note_symbol() return the modified huxtable.

Arguments

ht

A huxtable.

value

One of "numeric", "roman" or "alphabetic", or a non-empty string whose individual characters form a custom symbol sequence. Set to NA to reset to the default, which is "numeric".

Details

Numeric symbols are 1, 2, ...; Roman symbols are i, ii, ...; and alphabetic symbols are a, b, ..., z, aa, .... Custom strings are treated like a custom alphabet. For example, "+*" produces +, *, ++, +*, *+, ....

Custom Unicode symbols require support from the output format's font and rendering engine.

Examples

ht <- set_cell_note(jams, 1, 1, "Price estimated")
ht <- set_note_symbol(ht, "+*")
note_symbol(ht)