Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 45 lines (40 sloc) 1.596 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
\name{annotate}
\alias{annotate}
\title{Create an annotation layer.}
\usage{
  annotate(geom, x = NULL, y = NULL, xmin = NULL,
    xmax = NULL, ymin = NULL, ymax = NULL, ...)
}
\arguments{
  \item{geom}{name of geom to use for annotation}

  \item{x,y,xmin,ymin,xmax,ymax}{positionining aesthetics -
  you must specify at least one of these.}

  \item{...}{other aesthetics. These are not scaled so you
  can do (e.g.) \code{colour = "red"} to get a red point.}
}
\description{
  This function adds geoms to a plot. Unlike typical a geom
  function, the properties of the geoms are not mapped from
  variables of a data frame, but are instead in as vectors.
  This is useful for adding small annotations (such as text
  labels) or if you have your data in vectors, and for some
  reason don't want to put them in a data frame.
}
\details{
  Note that all position aesthetics are scaled (i.e. they
  will expand the limits of the plot so they are visible),
  but all other aesthetics are set. This means that layers
  created with this function will never affect the legend.
}
\examples{
p <- ggplot(mtcars, aes(x = wt, y = mpg)) + geom_point()
p + annotate("text", x = 4, y = 25, label = "Some text")
p + annotate("text", x = 2:5, y = 25, label = "Some text")
p + annotate("rect", xmin = 3, xmax = 4.2, ymin = 12, ymax = 21,
  alpha = .2)
p + annotate("segment", x = 2.5, xend = 4, y = 15, yend = 25,
  colour = "blue")
p + annotate("pointrange", x = 3.5, y = 20, ymin = 12, ymax = 28,
  colour = "red", size = 1.5)

p + annotate("text", x = 2:3, y = 20:21, label = c("my label", "label 2"))
}

Something went wrong with that request. Please try again.