xgx_annotate_status: Create a status (e.g. DRAFT) annotation layer

Description Usage Arguments Value Examples

View source: R/xgx_annotate_status.R

Description

xgx_annotate_status adds a status (e.g. DRAFT) annotation layer to a plot. The text of the annotation can be customized, the default is "DRAFT". The color, location, size, fontface, transparency of the annotation can also be customized.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
xgx_annotate_status(
  status = "DRAFT",
  x = Inf,
  y = Inf,
  color = "grey",
  hjust = 1.2,
  vjust = 1.2,
  fontsize = 7,
  fontface = "bold",
  alpha = 0.5,
  ...
)

Arguments

status

the text to

x

x location, default Inf (right most point)

y

y location, default Inf (up most point)

color

font color, default "grey"

hjust

horizontal justification, default 1.2

vjust

vertical justification, default 1.2

fontsize

font size to use, default 7

fontface

font style to use, default "bold"

alpha

transparency, default is 0.5

...

other arguments passed on to layer

Value

ggplot layer

Examples

1
2
3
4
data <- data.frame(x = 1:1000, y = rnorm(1000))
ggplot2::ggplot(data = data, ggplot2::aes(x = x, y = y)) + 
  ggplot2::geom_point() +
  xgx_annotate_status("DRAFT")

xgxr documentation built on April 23, 2021, 1:07 a.m.