Skip to contents

Read the footer a table would print

Source: R/tab-footer.R
tab_footer_text.Rd

The lines tabxplor prints under a table, resolved: the template's placeholders built, the user's own lines as written. It is what set_subtext() edits, after the fact.

Usage

tab_footer_text(
  x,
  medium = c("plain", "console", "html", "md"),
  style = NULL,
  lang = NULL,
  theme = NULL
)

Arguments

x

A tabxplor_tab.

medium

One of "plain" (default), "console", "html", "md".

style

"terse" (the console's compact one-liner) or "prose" (full sentences, the exports' default); NULL follows the medium.

lang

NULL (from getOption("tabxplor.lang")), "en" or "fr".

theme

Palette theme; NULL follows the medium's option.

Value

A character vector, one element per footer line.

See also

set_subtext() for the template, set_legend_words() for the words.

Examples

t <- tab(forcats::gss_cat, race, marital, pct = "row", color = "diff")
cat(tab_footer_text(t), sep = "\n")
#> Percentage points (risk) difference: cell ≥ the Total row +5; +15; +30 points; cell ≤ the Total row -5; -15; -30 points.