tfplot: Plot Tframed Objects
In tfplot: Time Frame User Utilities

Description Usage Arguments Details Value Side Effects See Also Examples

View source: R/tfplot.R

Plot tframe or tframed objects.

    tfplot(x, ...)

    ## Default S3 method:
tfplot(x, ..., tf=tfspan(x, ...), start=tfstart(tf), end=tfend(tf),
       series=seq(nseries(x)), 
        Title=NULL, title=Title, subtitle=NULL, 
        lty = 1:5, lwd = 1, pch = 1, col = 1:6, cex = NULL,
        xlab=NULL, ylab=seriesNames(x), xlim = NULL, ylim = NULL, 
        graphs.per.page=5, par=NULL, reset.screen=TRUE, 
        Xaxis="auto", L1=NULL,
	YaxisL=TRUE, YaxisR=FALSE, Yaxis.lab.rot = "vertical",
	splitPane=NULL,
        lastObs = FALSE, source = NULL,
        footnote = NULL, footnoteLeft = footnote, footnoteRight = NULL,
	legend=NULL, legend.loc="topleft")
    tfOnePlot(x, tf=tframe(x), start=tfstart(tf), end=tfend(tf),
        Title=NULL, title=Title,  subtitle=NULL, 
	lty=1:5, lwd=1, pch=1, col=1:6, cex=NULL,
        xlab=NULL, ylab=NULL, xlim=NULL, ylim=NULL, par=NULL,
	Xaxis="auto", L1=NULL,
	YaxisL=TRUE, YaxisR=FALSE, Yaxis.lab.rot = "vertical",
	splitPane=NULL,
	lastObs=FALSE,  source=NULL, 
	footnote=NULL, footnoteLeft=footnote, footnoteRight=NULL,
	legend=NULL, legend.loc="topleft")

`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).
`Title`	synonym for title.
`subtitle`	string to use for plot subtitle (but see details).
`lty`	passed to plot. See also par.
`lwd`	passed to plot. See also par.
`pch`	passed to plot. See also par.
`col`	passed to plot. See also par.
`cex`	passed to plot. 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 plot. See also par.
`ylim`	passed to plot. See also par.
`Xaxis`	If equal 'auto' then an attempt is made at a better format for the x-axis tick marks and their labels. A value of `NULL` produces the result using plot defaults (as previously).
`YaxisL`	logical indicating if a left Y axis should be on the graph.
`YaxisR`	logical or numeric indicating if a right Y axis should be on the graph. A numeric value indicates its scale relative to the left axis.
`Yaxis.lab.rot`	'vertical' or 'horizontal' indicating the orientation of labels on the Y axis.
`L1`	A character vector used for the minor tick marks. The default is in english (e.g. the first letter of each month). It should be the same length as the frequency of `x`.
`lastObs`	Logical indicating if the date of the last observation should be printed below the graph, flushed right.
`splitPane`	An integer indicating the number of last observations that should be put in a second right panel (to show more detail at the end). `NULL` indicates no second panel.
`source`	String printed below the graph, flushed left.
`footnote`	Synonym for footnoteLeft.
`footnoteLeft`	String printed below lastObs and source, flushed left.
`footnoteRight`	String printed below lastObs and source, flushed right.
`legend`	`NULL` (indicating no legend) or a vector strings to be used for a legend (see legend)
`legend.loc`	indication of placement of the legend (see legend)
`graphs.per.page`	integer indicating number of graphs to place on a page.
`par`	a list of arguments passed to par() before plotting.)
`reset.screen`	logical indicating if the plot window should be cleared before starting. If this is not TRUE then par values will have no effect.

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.

tfplot does calls to tfOnePlot for each panel. tfOnePlot may give slightly better control, especially in cases where all series are to go on one plot. The functions are intended to provide a convenient way to do some usual things. Ultimately tfOnePlot calls plot, title, and mtext, so even more control of plot details can be achieved by calling those functions directly.

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.

Xaxis provides a mechanism to try and achieve a better default axis. If equal 'auto' then an attempt is made at a format with large tick marks for years and smaller tick marks for periods (months or quarters). If the number of years is sufficiently small, so there is enough space, then period indications are added. The default, indicated by L1=NULL, is the c('Q1', Q2', Q3', 'Q4') will be used for quarterly data and c("J","F","M","A","M","J","J","A","S","O","N","D") for monthly data. Different values can be specified by setting L1. It should be the same length as the frequency of x. If Xaxis is set to NULL then the result is to use plot defaults (as prior to the addition of the Xaxis argument in version 2013.11-1). Currently Xaxis='auto' only affects annual, monthly, and quarterly data, and the affect on annual data is marginal.

YaxisL set TRUE or FALSE controls if left axis tick marks and labels are put on the plot. If YaxisR is FALSE then right axis tick marks and labels are not put on the plot. If it is TRUE then they are put on the plot with the same scale as the left axis (or as it would have if it were plotted). If YaxisR is a numeric value then the right axis is put on the plot with the scale of the left axis multiplied by the numeric value. The data is plotted using the left scale, so the user must appropriately adjust any values to be read on the right scale (divide by YaxisR). YaxisR can be a vector of length equal to the number of series in x, in which case a scale element is applied to the corresponding plot panel. If YaxisR is shorter it is recycled, so a scalar value is applied to all panels.

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).

Similarly, options(PlotPlotSubtitles=FALSE), options(PlotSources=FALSE), and options(PlotFootnotes=FALSE) can be used to suppress printing of these.

Footnotes can contain "\n" to produce multiline, or multiple footnotes. However, if source and lastObs are speciied then the overlap can be messy. In this case a better result might be obtained by specifying the source as part of the footnote.

If subtitle, source, footnoteLeft, footnoteRight or legend.loc have length less than the number of panels then they are replicated, so typically they should have one element that is applied to each panel, or be vectors with one element for each panel. For tfOnePlot these should all have length 1. If legend is a matrix then a column will be used for each panel, otherwise the vector will be passed to each panel. (Typically this vector has length equal to the number of series in each panel graph.)

The par argument can be used to pass other graphics parameters to tfplot and tfOnePlot (see par). These are set by a call par(par) in tfplot or tfOnePlot. tfplot makes this call and does not pass par to tfOnePlot, so the result may sometimes be different from making a direct call to tfOnePlot and providing the par argument. Some of the margin (mar) setting are overridden by split plots, so the results may not be predictable for this case.