Get and set referential footnotes on aspects of a built table
Usage
row_footnotes(obj)
row_footnotes(obj) <- value
cell_footnotes(obj)
cell_footnotes(obj) <- value
col_fnotes_here(obj)
col_fnotes_here(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) <- valueArguments
- obj
ANY. The object for the accessor to access or modify
- value
The new value
- rowpath
character or NULL. Path within row structure.
NULLindicates the footnote should go on the column rather than cell.- colpath
character or NULL. Path within column structure.
NULLindicates 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.
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