unikn: heading – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

heading

Plot a heading (as marked text elements).

Description

heading plots 1 or more text strings (provided as a character vector labels) as a heading to an (existing or new) plot and places a colored box behind each label to mark it (i.e., highlighting the heading).

Usage

heading(
  labels,
  x = 0,
  y = 0.8,
  y_layout = "flush",
  col = "black",
  col_bg = "default",
  cex = 2,
  font = 2,
  new_plot = "slide"
)

Arguments

`labels`	A character vector specifying the text labels to be plotted.
`x`	A numeric vector of x-coordinates at which the text labels in `labels` should be written. If the lengths of `x` and `y` differ, the shorter one is recycled. Default: `x = 0`.
`y`	A numeric vector of y-coordinates at which the text labels in `labels` should be written. If the lengths of `x` and `y` differ, the shorter one is recycled. Default: `y = .8`.
`y_layout`	A numeric value or vector for the vertical spacing of labels in `labels`. 2 special values are `"even"` (i.e., even distribution of labels across available y-space) and `"flush"` (i.e., no space between adjacent labels, or `y_layout = 0`). Default: `y_layout = "flush"`.
`col`	The color(s) of the text label(s). Default: `col_lbl = "black"`.
`col_bg`	The color(s) to highlight or fill the rectangle(s) with. Default: `col_bg = "default"` (to automatically select different shades of `pal_seeblau`).
`cex`	Numeric character expansion factor(s), multiplied by `par("cex")` to yield the character size(s). Default: `cex = 2`.
`font`	The font type(s) to be used. Default: `font = 2` (i.e., bold).
`new_plot`	Boolean: Should a new plot be generated? Set to `"blank"` or `"slide"` to create a new plot, and to `"none"` to add to an existing plot. Default: `new_plot = "slide"` (i.e., create a new `slide`).

Details

Text formatting parameters (like col, col_bg, cex, font) are recycled to match length(labels).

heading uses the base graphics system graphics::.

Examples

heading(labels = c("This is a headline", "containing two lines."))

# Note the warning:
heading(labels = c("Headlines", "with 3 or more lines", 
                 "should not be arranged", "in such a step-wise fashion.")) 

# Avoiding the warning:
heading(labels = c("Headlines with", "3 or more lines should", 
                   "not be arranged", "in a step-wise fashion."))

# Using non-default colors:
heading(labels = c("Ene,", "mene, miste,", "es rappelt", "in der Kiste."), 
        cex = 1.6, col = "white", col_bg = usecol(c(Pinky, Seegruen, Bordeaux, Karpfenblau)))

#' @family text functions

unikn

Graphical Elements of the University of Konstanz's Corporate Design

v0.4.0

CC BY-SA 4.0

Authors

Hansjoerg Neth [aut, cre] (<https://orcid.org/0000-0001-5427-3141>), Nico Gradwohl [aut] (<https://orcid.org/0000-0002-8703-905X>)

Initial release

2021-03-25