lares (version 5.0.6)

formatText: Format a string text as markdown/HTML

Description

Format any character string to HTML or markdown format. We recommend using this format with the ggtext::geom_richtext function to format text in ggplot2 objects.

Usage

formatText(text, color = "black", size = 20, bold = FALSE)

Arguments

text

Character. Strings to format.

color

Character. Hex colour code.

size

Numeric. Text size.

bold

Boolean. Should the text be bold?

Value

String with format characters included.

Examples

# NOT RUN {
formatText("Text test", color = "#000000")
formatText(c(123, 456), color = "orange", size = 120, bold = TRUE)

# If you want to use it with \code{ggtext}:
# }
# NOT RUN {
col1 <- "grey"
col2 <- "orange"
pt <- data.frame(
  label = paste0(
    formatText(123, color = col2, size = 120, bold = TRUE), "<br/>",
    formatText("of children had a", col1), "<br/>",
    formatText("traditional stay-at-home mom", color = col2, bold = TRUE), "<br/>",
    formatText(paste0("in 2012, compared to ", 321, " in 1970"), color = col1)
  )
)
ggplot(pt, aes(x = 0, y = 0)) +
  ggtext::geom_richtext(
    aes(label = label),
    hjust = 0,
    label.color = NA,
    lineheight = 1.5
  ) +
  xlim(0, 0.01) +
  theme_void()
# }