xts (version 0.14.1)

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

An xts object of events and their associated labels. It is ensured 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

Ross Bennett

Examples

if (FALSE) {
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)
}