row_footnotes {rtables} | R Documentation |
Referential footnote accessors
Description
Access and set the referential footnotes aspects of a built table.
Usage
row_footnotes(obj)
row_footnotes(obj) <- value
cell_footnotes(obj)
cell_footnotes(obj) <- value
col_fnotes_here(obj)
## S4 method for signature 'ANY'
col_fnotes_here(obj)
col_fnotes_here(obj) <- value
col_footnotes(obj)
col_footnotes(obj) <- value
ref_index(obj)
ref_index(obj) <- value
ref_symbol(obj)
ref_symbol(obj) <- value
ref_msg(obj)
fnotes_at_path(obj, rowpath = NULL, colpath = NULL, reset_idx = TRUE) <- value
Arguments
obj |
( |
value |
( |
rowpath |
( |
colpath |
( |
reset_idx |
( |
See Also
row_paths()
, col_paths()
, row_paths_summary()
, col_paths_summary()
Examples
# How to add referencial footnotes after having created a table
lyt <- basic_table() %>%
split_rows_by("SEX", page_by = TRUE) %>%
analyze("AGE")
tbl <- build_table(lyt, DM)
tbl <- trim_rows(tbl)
# Check the row and col structure to add precise references
# row_paths(tbl)
# col_paths(t)
# row_paths_summary(tbl)
# col_paths_summary(tbl)
# Add the citation numbers on the table and relative references in the footnotes
fnotes_at_path(tbl, rowpath = c("SEX", "F", "AGE", "Mean")) <- "Famous paper 1"
fnotes_at_path(tbl, rowpath = c("SEX", "UNDIFFERENTIATED")) <- "Unfamous paper 2"
# tbl
[Package rtables version 0.6.9 Index]