filtering-plot function

Plot Method for tsdecFilter Objects

Plot the time series containing the components in a tsdecFilter object.

## S3 method for class 'tsdecFilter'
plot(x, select = colnames(X), 
  overlap.trend = FALSE, args.trend = list(col = "black"),
  set.pars = list(mar = c(0, 3, 0, 3), oma = c(4, 0, 2, 0), mfrow = c(nplot, 1)),
  main = NULL, range.bars = TRUE, ..., 
  col.range = "light gray", 
  args.xlab = list(text = "time", side = 1, line = 2), 
  args.ylab = list(side = 3, adj = 0, line = -1),
  xaxis.line = -0.5)

Arguments

• x: an object of class tsdecFilter returned by filtering.
• select: character vector with the labels of the series to be plot. Allowed values are c("observed", "trend", "transitory", "seasonal", "sadj", "irregular").

,

• overlap.trend: logical, if TRUE the trend component is plot over the observed data; otherwise, the trend is plot separately.

• args.trend: a list containing the arguments to be passed to lines. If overlap.trend=TRUE, these options are used to plot the trend; otherwise, it is ignored.

• set.pars: settings for par(.) when setting up the plot.

• main: plot main title.

• range.bars: logical indicating if each plot should have a bar at its right side which are of equal heights in user coordinates. The same as in plot.stl.

• ...: further arguments passed to plot.

• col.range: colour to be used for the range bars, if plotted. Note this appears after ... and so cannot be abbreviated.

• args.xlab: arguments to be passed to mtext

  when setting the title for the x axis.

• args.ylab: arguments to be passed to mtext

  when setting the title for the y axis.

• xaxis.line: the number of lines into the margin at which the x axis line will be drawn.

Details

This function is based on plot.stl.

See Also

filtering.