add_footnote: Add a row with a footnote

Description Usage Arguments Value Examples

View source: R/misc.R

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

1
add_footnote(ht, text, border = 0.8, ...)

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.

...

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

Value

The modified huxtable

Examples

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

Example output

  Type                    Price  
  Strawberry               1.90  
  Raspberry                2.10  
  Plum                     1.80  
<U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500><U+2500>
  * subject to availability      

Column names: Type, price

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