forked from plotly/plotly.R
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathadd_annotations.Rd
More file actions
39 lines (31 loc) · 884 Bytes
/
add_annotations.Rd
File metadata and controls
39 lines (31 loc) · 884 Bytes
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/add.R
\name{add_annotations}
\alias{add_annotations}
\title{Add an annotation(s) to a plot}
\usage{
add_annotations(p, text = NULL, ..., data = NULL, inherit = TRUE)
}
\arguments{
\item{p}{a plotly object}
\item{text}{annotation text (required).}
\item{...}{these arguments are documented at \url{https://plot.ly/r/reference/#layout-annotations}}
\item{data}{a data frame.}
\item{inherit}{inherit attributes from \code{\link{plot_ly}()}?}
}
\description{
Add an annotation(s) to a plot
}
\examples{
# single annotation
plot_ly(mtcars, x = ~wt, y = ~mpg) \%>\%
slice(which.max(mpg)) \%>\%
add_annotations(text = "Good mileage")
# multiple annotations
plot_ly(mtcars, x = ~wt, y = ~mpg) \%>\%
filter(gear == 5) \%>\%
add_annotations("five cylinder", ax = 40)
}
\author{
Carson Sievert
}