Attach subordinate tables under a table

Records one or more tabxplor_tabs that BELONG to x and are rendered under it by every medium — the console, tab_md, tab_html and tab_xl — exactly as if they had been passed in one list, and which travel with x through a dplyr pipeline (they are kept in x's meta$footer_tabs).

The use is a fact that belongs to the table without being a row of it: the eigenvalues of the axes beside a factorial-analysis summary, a sample description beside the result it describes.

Usage

set_footer_tabs(x, tabs)

get_footer_tabs(x)

Arguments

x

A tabxplor_tab.

tabs

A tabxplor_tab, a list of them, or NULL to remove whatever is attached. A named element is captioned with its name (set_caption) unless it carries a caption already.

Value

x, with its subordinate tables set (set_footer_tabs) ; the list of them, or NULL when none (get_footer_tabs).

See also

new_tab() for the whole meta record.

Examples

main <- tab(forcats::gss_cat, race, marital, pct = "row")
side <- tab(forcats::gss_cat, race)
main <- set_footer_tabs(main, list("Base" = side))
get_footer_tabs(main)
#> $Base
#> # A tabxplor tab: 4 × 2
#>   race        n
#>             <n>
#> 1 Other   1 959
#> 2 Black   3 129
#> 3 White  16 395
#> 4 Total  21 483
#>