rtables (version 0.4.0)

row_footnotes: Referential Footnote Accessors

Description

Get and set referential footnotes on aspects of a built table

Usage

row_footnotes(obj)
# S4 method for TableRow
row_footnotes(obj)
# S4 method for RowsVerticalSection
row_footnotes(obj)
row_footnotes(obj) <- value
# S4 method for TableRow
row_footnotes(obj) <- value
# S4 method for ElementaryTable
row_footnotes(obj)
cell_footnotes(obj)
# S4 method for CellValue
cell_footnotes(obj)
# S4 method for TableRow
cell_footnotes(obj)
# S4 method for LabelRow
cell_footnotes(obj)
# S4 method for ElementaryTable
cell_footnotes(obj)
cell_footnotes(obj) <- value
# S4 method for CellValue
cell_footnotes(obj) <- value
# S4 method for DataRow
cell_footnotes(obj) <- value
# S4 method for ContentRow
cell_footnotes(obj) <- value
col_fnotes_here(obj)
# S4 method for LayoutColTree
col_fnotes_here(obj)
# S4 method for LayoutColLeaf
col_fnotes_here(obj)
col_fnotes_here(obj) <- value
# S4 method for LayoutColTree
col_fnotes_here(obj) <- value
# S4 method for LayoutColLeaf
col_fnotes_here(obj) <- value
ref_index(obj)
# S4 method for RefFootnote
ref_index(obj)
ref_index(obj) <- value
# S4 method for RefFootnote
ref_index(obj) <- value
fnotes_at_path(obj, rowpath = NULL, colpath = NULL, reset_idx = TRUE) <- value
# S4 method for VTableTree,character
fnotes_at_path(obj, rowpath = NULL, colpath = NULL, reset_idx = TRUE) <- value
# S4 method for VTableTree,`NULL`
fnotes_at_path(obj, rowpath = NULL, colpath = NULL, reset_idx = TRUE) <- value

Arguments

obj

ANY. The object for the accessor to access or modify

value

The new value

rowpath

character or NULL. Path within row structure. NULL indicates the footnote should go on the column rather than cell.

colpath

character or NULL. Path within column structure. NULL indicates footnote should go on the row rather than cell

reset_idx

logical(1). Should the numbering for referential footnotes be immediately recalculated. Defaults to TRUE.