PerformanceAnalytics (version 1.4.3541)

chart.Events: Plots a time series with event dates aligned

Description

Creates a time series plot where events given by a set of dates are aligned, with the adjacent prior and posterior time series data plotted in order. The x-axis is time, but relative to the date specified, e.g., number of months preceeding or following the events.

Usage

chart.Events(R, dates, prior = 12, post = 12, main = NULL, xlab = NULL, ...)

Arguments

R

an xts, vector, matrix, data frame, timeSeries or zoo object of asset returns

dates

a list of dates (e.g., c("09/03","05/06")) formatted the same as in R. This function matches the re-formatted row or index names (dates) with the given list, so to get a match the formatting needs to be correct.

prior

the number of periods to plot prior to the event. Interpreted as a positive number.

post

the number of periods to plot following to the event. Interpreted as a positive number.

main

set the chart title, same as in plot

xlab

set the x-axis label, same as in plot

...

any other passthru parameters to the plot function

Details

This is a chart that is commonly used for event studies in econometrics, usually with recession dates, to demonstrate the path of a time series going into and coming out of an event. The time axis is simply the number of periods prior and following the event, and each line represents a different event. Note that if time periods are close enough together and the window shown is wide enough, the data will appear to repeat. That can be confusing, but the function does not currently allow for different windows around each event.

See Also

chart.TimeSeries, plot, par

Examples

## Not run: 
# data(managers)
# n = table.Drawdowns(managers[,2,drop=FALSE])
# chart.Events(Drawdowns(managers[,2,drop=FALSE]),
# 		dates = n$Trough,
# 		prior=max(na.omit(n$"To Trough")),
# 		post=max(na.omit(n$Recovery)),
# 		lwd=2, colorset=redfocus, legend.loc=NULL,
# 		main = "Worst Drawdowns")
# ## End(Not run)