Cell Value constructor

Usage

CellValue(
  val,
  format = NULL,
  colspan = 1L,
  label = NULL,
  indent_mod = NULL,
  footnotes = NULL,
  align = NULL,
  format_na_str = NULL
)

Arguments

val

ANY. value in the cell exactly as it should be passed to a formatter or returned when extracted

format

FormatSpec. Format associated with this split. Formats can be declared via strings ("xx.x") or function. In cases such as analyze calls, they can character vectors or lists of functions.

colspan

integer(1). Column span value.

label

character(1). A label (not to be confused with the name) for the object/structure.

indent_mod

numeric. Modifier for the default indent position for the structure created by this function(subtable, content table, or row) and all of that structure's children. Defaults to 0, which corresponds to the unmodified default behavior.

footnotes

list or NULL. Referential footnote messages for the cell.

align

character(1) or NULL. Alignment the value should be rendered with. It defaults to "center" if NULL is used. See rtables_aligns for currently supported alignments.

format_na_str

character(1). String which should be displayed when formatted if this cell's value(s) are all NA.

Value

An object representing the value within a single cell within a populated table. The underlying structure of this object is an implementation detail and should not be relied upon beyond calling accessors for the class.