xts: addEventLines – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

xts

addEventLines

Add vertical lines to an existing xts plot

Description

Add vertical lines and labels to an existing xts plot

Usage

addEventLines(events, main = "", on = 0, lty = 1, lwd = 1, col = 1, ...)

Arguments

`events`	xts object of events and their associated labels. It is assumed that the first column of `events` is the event description/label.
`main`	main title for a new panel if drawn.
`on`	panel number to draw on. A new panel will be drawn if `on=NA`. The default, `on=0`, will add to the active panel. The active panel is defined as the panel on which the most recent action was performed. Note that only the first element of `on` is checked for the default behavior to add to the last active panel.
`lty`	set the line type, same as in `par`.
`lwd`	set the line width, same as in `par`.
`col`	color palette to use, set by default to rational choices.
`...`	any other passthrough parameters to `text` to control how the event labels are drawn

Author(s)

Ross Bennett

Examples

## Not run: 
library(xts)
data(sample_matrix)
sample.xts <- as.xts(sample_matrix)
events <- xts(letters[1:3], 
              as.Date(c("2007-01-12", "2007-04-22", "2007-06-13")))
plot(sample.xts[,4])
addEventLines(events, srt=90, pos=2)

## End(Not run)

xts

eXtensible Time Series

v0.12.1

GPL (>= 2)

Authors

Jeffrey A. Ryan [aut, cph], Joshua M. Ulrich [cre, aut], Ross Bennett [ctb], Corwin Joy [ctb]

Initial release