tfplot {tframe}R Documentation

Plot Tframed Objects

Description

Plot tframe or tframed objects.

Usage

    tfplot(x, ...)

    ## Default S3 method:
    tfplot(x, ..., tf=tfspan(x, ...), start=tfstart(tf), end=tfend(tf),
       series=seq(nseries(x)), Title=NULL, 
        lty = 1:5, lwd = 1, pch = NULL, col = 1:6, cex = NULL,
       xlab=NULL, ylab=seriesNames(x), xlim = NULL, ylim = NULL, 
       graphs.per.page=5, par=NULL, mar=par()$mar, reset.screen=TRUE)
    tfOnePlot(x, tf=tframe(x), start=tfstart(tf), end=tfend(tf),
        lty=1:5, lwd=1, pch=NULL, col=1:6, cex=NULL,
        xlab=NULL, ylab=NULL, xlim=NULL, ylim=NULL, ...)

Arguments

x a tframe or tframed object to plot.
... any additional tframed objects for the same plot.
start start of plot. (passed to tfwindow)
end end of plot. (passed to tfwindow)
tf a tframe or tframed object which can be used to specify start and end.
series series to be plotted. (passed to selectSeries)
Title string to use for plot title (but see details).
lty passed to matplot. See also par.)
lwd passed to matplot. See also par.)
pch passed to matplot. See also par.)
col passed to matplot. See also par.)
cex passed to matplot. See also par.)
xlab string to use for x label (passed to plot).
ylab string to use for y label (passed to plot).
xlim passed to matplot. See also par.)
ylim passed to matplot. See also par.)
graphs.per.page integer indicating number of graphs to place on a page.
par a list of arguments passed to par() before plotting.)
mar margins passed to plot (deprecated, use par).)
reset.screen logical indicating if the plot window should be cleared before starting. If this is not TRUE then mar values will have no effect.

Details

In many cases these are the same as plot methods, however, tfplot puts different series in the object x in different plot panels, whereas plot usually puts them in the same panel. For this reason, tfplot tends to work better when the scale of the different series are very different. If additional objects are supplied, then they should each have the same number of series as x and all corresponding series will be plotted in the same panel.

tfplot provides an alternate generic mechanism for plotting time series data. New classes of time series may define there own tfplot (and plot) methods.

The start and end arguments to tfplot determine the start and end of the plot. The argument tf is an alternate way to specify the start and end. It is ignored if start and end are specified.

If xlim and ylim are not NULL they should be a vector of two elements giving the max and min, which are applied to all graphs, or a list of length equal to the number of series to be plotted with each list element being the two element vector for the corresponding plot limits.

The Title is not put on the plot if the global option PlotTitles is FALSE. This can be set with options(PlotTitles=FALSE). This provides a convenient mechanism to omit all titles when the title may be added separately (e.g. in Latex).

Value

None.

Side Effects

An object is plotted.

See Also

tfprint tframe tframed print plot matplot par

Examples

    tfplot(ts(rnorm(100), start=c(1982,1), frequency=12))
    tfplot(ts(rnorm(100), start=c(1982,1), frequency=12), start=c(1985,6))

[Package tframe version 2009.2-1 Index]