stamp_text_ljust: Stamp some text, left justified

In EvaMaeRey/ggstamp: Annotation in ggplot using stamp_* functions

Stamp some text, left justified

Description

This function adds a text annotation layer

Usage

stamp_text_ljust(
  x = 0 + nudge_x,
  y = 0 + nudge_y,
  label = "some\ntext",
  text_wrap = FALSE,
  char_width = 40,
  alpha = 1,
  angle = 0,
  color = "black",
  family = "Times",
  fontface = "bold",
  hjust = 0,
  lineheight = 0.85,
  size = 8,
  vjust = 0.5,
  xy = NULL,
  parse = FALSE,
  nudge_x = 0,
  nudge_y = 0
)

Arguments

label	defaults with a message about use
alpha	numeric between 0 and 1 indicating transparency, defaults to 1 fully opaque, zero is fully transparent
color	a character string indicating color, defaults to "black", for other named colors check out https://evamaerey.github.io/ggplot2_grammar_guide/named_colors
family	font family
hjust	horizontal justification, between 0 and 1, defaults to .5
lineheight	spacing between lines if text is wrapped
size	size of text
vjust	vertical justification, between 0 and 1, defaults to .5
xy	a data frame where the first two columns contain x and y positional values
parse	If TRUE, the labels will be parsed into expressions and displayed as described in ?plotmath.
nudge_x	Horizontal adjustment to nudge labels by. Useful for offsetting text from points, particularly on discrete scales.
nudge_y	Vertical adjustment to nudge labels by. Useful for offsetting text from points, particularly on discrete scales.

Examples

# stamping text on a plot
library(ggplot2)
ggplot(cars) +
 aes(speed, dist) +
 geom_point() +
 stamp_text_ljust(label = "A 1920s study on speed v. stopping distance ...",
            x = 3, y = 110,
            size = 5,
            text_wrap = TRUE,
            hjust = 0) +
 stamp_text_ljust(label = "The Pearson\ncorrelation\nis about 0.81",
           x = 18, y = 15,
           size = 5, hjust = 0) +
 stamp_text_ljust(label = 'bold(italic(p)*"-value"<"0.01")',
            parse = TRUE,
            size = 5, x = 23, y = 2)
 cor.test(cars$speed, cars$dist)

# some more
 ggcanvas() +
  stamp_text_ljust() +
  stamp_text_ljust(label = letters[1:4],
  xy = pos_polygon(n = 4)) +
  stamp_text_ljust(x = 2) +
  scale_x_continuous(limits = c(-1,3)) +
  stamp_text(y = 1:2, x = 2,
             label = "Hello\nthere!") +
  theme_void() +
  stamp_point(x = 1, y = 1,
              alpha = .4) +
  theme(plot.background =
       element_rect(fill = "seagreen",
       size = 0)) +
  scale_y_continuous(limits = c(-1,3))

EvaMaeRey/ggstamp documentation built on June 30, 2022, 11 p.m.