Skip to contents

Get the Current Study-Level Table Theme

Source: R/api-theme.R
fr_theme_get.Rd

Returns the current study-level theme as a named list. Use this to inspect what defaults have been set via fr_theme().

Usage

fr_theme_get()

Value

A named list of current theme settings, or an empty list if no theme has been set. Possible keys (all optional):

  • orientation — "landscape" or "portrait"

  • paper — "letter", "a4", "legal"

  • font_family — e.g. "Courier New"

  • font_size — numeric (points)

  • margins — numeric vector (inches)

  • tokens — named list of token values

  • pagehead — list with left, center, right, font_size, bold

  • pagefoot — list with left, center, right, font_size, bold

  • hlines — preset name (e.g. "header")

  • vlines — preset name (e.g. "box")

  • spacing — list with titles_after, footnotes_before, pagehead_after, pagefoot_before, page_by_after (integer blank lines)

  • col_gap — integer (points)

  • split — logical (TRUE/FALSE) column splitting

  • stub — character vector (stub column names)

  • page_by_bold — logical; whether page-by labels are bold

  • page_by_align — character; alignment of page-by labels

  • page_by_visible — logical; whether page-by labels are displayed

  • group_keep — logical; whether group_by groups are kept together

  • footnote_separator — logical

See also

fr_theme() to set, fr_theme_reset() to clear, fr_config_get() for YAML config inspection.

Examples

fr_theme(font_size = 9, hlines = "header", orientation = "landscape")
fr_theme_get()
#> $orientation
#> [1] "landscape"
#> 
#> $font_size
#> [1] 9
#> 
#> $hlines
#> [1] "header"
#> 
# $font_size
# [1] 9
# $hlines
# [1] "header"
# $orientation
# [1] "landscape"

# Programmatic access
theme <- fr_theme_get()
theme$font_size   # 9
#> [1] 9

## ── Empty state after reset ───────────────────────────────────────────────

fr_theme_reset()
fr_theme_get()     # list() — no theme settings active
#> list()
length(fr_theme_get()) == 0L   # TRUE
#> [1] TRUE