Skip to contents

Patchwork Annotation with Rich Text

Source: R/patchwork-annotation.R
munch_annotation.Rd

A replacement for patchwork::plot_annotation() that supports element_chunks() and element_md() for the title, subtitle, and/or caption of a combined patchwork plot.

Each text argument accepts:

  • An element_chunks() or element_md() object — rendered as rich text with auto-wrapping; all formatting options (hjust, lineheight, margin, etc.) are set inside the element call.

  • A bare flextable::as_paragraph() object — wrapped in element_chunks() with default settings.

  • A plain character string — passed through unchanged.

  • NULL — element omitted.

Patchwork only renders an annotation element when a non-NULL string is provided to patchwork::plot_annotation(). For element/chunks-based inputs, munch_annotation supplies an invisible sentinel string so patchwork creates the layout row, while element_chunks() or element_md() handles the actual rendering using the stored content (the label is ignored).

Usage

munch_annotation(
  caption = NULL,
  title = NULL,
  subtitle = NULL,
  tag_levels = NULL,
  tag_prefix = NULL,
  tag_suffix = NULL,
  tag_sep = NULL,
  theme = NULL
)

Arguments

caption

An element_chunks(), element_md(), flextable::as_paragraph() object, a plain character string, or NULL.

title

Same as caption.

subtitle

Same as caption.

tag_levels, tag_prefix, tag_suffix, tag_sep

Passed through to patchwork::plot_annotation().

theme

Additional ggplot2::theme() elements merged on top of any element themes derived from title, subtitle, or caption.

Value

An object of class c("munch_annotation", "gg") that can be added to a patchwork object with +.

Examples

library(ggplot2)
library(patchwork)
library(flextable)

library(gdtools)
font_set_liberation()
#> Font set
#>   sans:    Liberation Sans [liberation]
#>   serif:   Liberation Serif [liberation]
#>   mono:    Liberation Mono [liberation]
#>   symbol:  Liberation Sans [liberation]
#>   4 HTML dependencies
set_flextable_defaults(
  font.size = 12,
  font.family = "Liberation Sans"
)
p1 <- ggplot(mtcars, aes(mpg, wt)) + geom_point()
p2 <- ggplot(mtcars, aes(hp, wt)) + geom_point()

caption_chunks <- as_paragraph(
  as_chunk("R"), as_sup("2"), as_chunk(" = 0.75")
)

plot_obj <- wrap_plots(p1, p2) +
  munch_annotation(
    title   = "A plain string title",
    caption = element_chunks(caption_chunks, lineheight = 1.5, hjust = 0)
  )
x <- girafe(
  plot_obj,
  options = list(opts_sizing(rescale = FALSE)),
  dependencies = list(
    liberationsansHtmlDependency()
  )
)
x