ttl: Creates a title attribute

In reporter: Creates Statistical Reports

Creates a title attribute

Description

This function creates a titles attribute, which can be used to define titles by attaching as an attribute to a data frame. This function is used internally to the system.

Usage

ttl(
  titles,
  align = "center",
  blank_row = "below",
  borders = NULL,
  width = NULL,
  bold = FALSE,
  font_size = NULL
)

Arguments

titles	A vector of title strings.
align	The position to align the titles. Valid values are 'left', 'right', 'center' or 'centre'. For titles, the default is 'center'.
blank_row	Where to place a blank row. Valid values are 'above', 'below', 'both', or 'none'. Default is "below".
borders	Whether and where to place a border. Valid values are 'top', 'bottom', 'left', 'right', 'outside', 'inside', 'all', or 'none'. Default is "none".
width	The width of the titles block.
bold	A parameter to bold the titles. Valid values are TRUE and FALSE. Default is FALSE.
font_size	The font size to use for the title block. The font size of the report will be used by default. Valid values are 8, 9, 10, 11, 12, 13, and 14.

Value

A title attribute object.

See Also

titles function.

Other attributes: ftn(), span()

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