R/urbn_note.R

In UrbanInstitute/urbnthemes: Additional theme and utilities for "ggplot2" in the Urban Institute style

#' urbn_note
#'
#' Add a notes section to the bottom of a plot created with \code{urbn_plot()}.
#'
#' @param text character string for a note
#' @param size font size for the note
#' @param width a number of characters to allow before a character return
#' @param plural If `TRUE`, will change "Note:" to "Notes:"
#'
#' @return a grob formatted for a source in a ggplot
#'
#' @export
#'
urbn_note <- function(text, size = 8, width = 132, plural = FALSE) {

  # should "Note:" be "Notes:" in the note
  if (!plural) {

    section_title <- "Note: "

  } else {

    section_title <- "Notes: "

  }

  # get the shorter first line
  wrapped_lines <- stringr::str_wrap(text, width = width - 6)

  line1 <- paste0(stringr::str_split(wrapped_lines, "\n", n = 2)[[1]][1], "\n")

  multiline <- length(stringr::str_split(wrapped_lines, "\n", n = 2)[[1]]) > 1

  if (multiline) {

    lines <- stringr::str_replace_all(stringr::str_split(wrapped_lines, "\n", n = 2)[[1]][2], "\n", " ")

    lines <- stringr::str_wrap(lines, width = width)

  }

  grob1 <- grid::textGrob(
    section_title,
    name = "note1",
    x = unit(0, "npc"),
    y = unit(1, "npc"),
    hjust = 0,
    vjust = 1,
    gp = gpar(fontsize = size, fontfamily = "Lato", fontface = "bold", lineheight = 1)
  )

  grob2 <- grid::textGrob(
    line1,
    x = unit(0, "npc") + grobWidth("note1"),
    y = unit(1, "npc"),
    hjust = 0,
    vjust = 1,
    gp = gpar(fontsize = size, fontfamily = "Lato", lineheight = 1)
  )


  if (multiline) {

    grob3 <- grid::textGrob(
      lines,
      x = unit(0, "npc"),
      y = unit(1, "npc") - 1.5 * grobHeight("note1"),
      hjust = 0,
      vjust = 1,
      gp = gpar(fontsize = size, fontfamily = "Lato", lineheight = 1)
    )

    grobTree(grob1, grob2, grob3)

  } else {

    grobTree(grob1, grob2)

  }
}