ftn: Creates a footnote attribute

In reporter: Creates Statistical Reports

Creates a footnote attribute

Description

The ftn function creates a footnote attribute, which may be attached as an attribute to a data frame and passed into create_table. This function is used internally to the system.

Usage

ftn(
  footnotes,
  align = "left",
  blank_row = "above",
  borders = "none",
  valign = NULL,
  width = NULL
)

Arguments

footnotes	A vector of footnote strings.
align	The position to align the footnotes. Valid values are: 'left', 'right', 'center', or 'centre'.
blank_row	Whether to print a blank row above or below the footnote. Valid values are 'above', 'below', 'both', or 'none'. Default is 'above'.
borders	Whether to print a border above or below the footnote. Valid values are 'top', 'bottom', 'outside', 'inside', 'all', or 'none'. Default is 'none'.
valign	The vertical position to align the footnotes. Valid values are: 'top' and 'bottom'.
width	The width of the footnotes block.

Value

The footnote attribute object.

See Also

footnotes to create a footnote.

Other attributes: span(), ttl()

reporter documentation built on May 29, 2024, 4:43 a.m.