add_footnote {huxtable}

Add a row with a footnote

Description

This adds a single row at the bottom. The first cell contains the footnote; it spans all table columns and has an optional border above.

Usage

add_footnote(ht, text, border = 0.8, number_format = NA, ...)

Arguments

ht

A huxtable.

text

Text for the footnote.

border

Width of the footnote's top border. Set to 0 for no border, or NULL to leave the border unchanged.

number_format

Number format for the footnote cell.

...

Other properties, passed to set_cell_properties() for the footnote cell.

Value

The modified huxtable

Examples

jams <- add_footnote(jams,
      "* subject to availability")
jams