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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/roller.R
\name{dyRoller}
\alias{dyRoller}
\title{dygraph rolling average period text box}
\usage{
dyRoller(dygraph, showRoller = TRUE, rollPeriod = 1)
}
\arguments{
\item{dygraph}{Dygraph to add roller to}
\item{showRoller}{Whether to show the roller}
\item{rollPeriod}{Number of time scale units (e.g. days, months, years) to
average values over.}
}
\value{
A dygraph that displays a range selector
}
\description{
Add a rolling average period text box to the bottom left of the plot. Y
values are averaged over the specified number of time scale units.
}
\note{
See the
\href{https://rstudio.github.io/dygraphs/gallery-roll-periods.html}{online
documentation} for additional details and examples.
}
\examples{
library(dygraphs)
dygraph(discoveries, main = "Important Discoveries") \%>\%
dyRoller(rollPeriod = 5)
}
|
