tframeMethods: Time Series Factor Methods for tframe Generics

In tsfa: Time Series Factor Analysis

Description

Plot or difference objects. See the generic descriptions.

Usage

   ## S3 method for class 'TSFmodel'
tframe(x) 

   ## S3 method for class 'TSFmodel'
tfplot(x, ..., tf=tfspan(x, ...), start=tfstart(tf), end=tfend(tf), 
		 series = seq(nfactors(x)), 
		 Title = "Model factors", 
		 lty = 1:5, lwd = 1, pch = NULL, col = 1:6, cex = NULL,
		 xlab = NULL, ylab = factorNames(x), xlim = NULL, ylim = NULL, 
		 graphs.per.page = 5,
                 par = NULL, reset.screen = TRUE)
   ## S3 method for class 'TSFfactors'
tfplot(x,..., tf=tfspan(x, ...), start=tfstart(tf), end=tfend(tf), 
		 series=seq(nfactors(x)),
		 Title="Estimated factors (dashed) and true (solid)", 
		 lty = c("dashed", "solid"), lwd = 1, pch = NULL, col = 1:6, cex = NULL,
		 xlab=NULL, ylab=factorNames(x), xlim = NULL, ylim = NULL, 
		 graphs.per.page=5, par=NULL, reset.screen=TRUE)
   ## S3 method for class 'TSFexplained'
tfplot(x,..., tf=tfspan(x, ...), start=tfstart(tf), end=tfend(tf), 
		 series=seq(nseries(x)),
		 Title="Explained (dashed) and actual data (solid)", 
		 lty = c("dashed", "solid"), lwd = 1, pch = NULL, col = 1:6, cex = NULL,
		 xlab=NULL, 
		 ylab=seriesNames(x), 
		 xlim = NULL, ylim = NULL,
		 graphs.per.page=5, par=NULL, reset.screen=TRUE)
   ## S3 method for class 'TSFmodelEstEval'
tfplot(x, ...,  tf=NULL, start=tfstart(tf), end=tfend(tf), 
		 series=seq(nseries(factors(x))),
		 Title="Monte Carlo Results", 
		 lty = c("solid", "dotdash", "dashed",  "dashed"), lwd = 1, pch = NULL, 
		 col = c("black", "red", "red", "red"), cex = NULL,
		 xlab=NULL, 
		 ylab=seriesNames(factors(x$truth)), 
		 xlim = NULL, ylim = NULL,
		 graphs.per.page=5, par=NULL, reset.screen=TRUE,
		 diff.=FALSE,  percentChange.=FALSE, 
		 PCcentered.=FALSE, summary.=TRUE)

    ## S3 method for class 'TSFmodel'
diff(x, ...)
    ## S3 method for class 'TSFexplained'
diff(x, ...)
    ## S3 method for class 'TSFfactors'
diff(x, ...)
    ## S3 method for class 'factorsEstEval'
diff(x, ...)

Arguments

x	an object.
x	a TSFmodel, TSFestModel, TSFexplained, or TSFfactors object for plotting or differencing.
diff.	logical indicating if differenced data should be plotted.
percentChange.	logical indicating if percent change data should be plotted.
PCcentered.	logical indicating if centered percent change data should be plotted.
summary.	logical indicating if mean and 1 SD bounds should be plotted in place of all estimates.
tf	See generic tfplot method
start	See generic tfplot method
end	See generic tfplot method
series	See generic tfplot method
Title	string to use for title of factors plot (but see details).
lty	See generic tfplot method
lwd	See generic tfplot method
pch	See generic tfplot method
col	See generic tfplot method
cex	See generic tfplot method
xlab	See generic tfplot method
ylab	See generic tfplot method
xlim	See generic tfplot method
ylim	See generic tfplot method
graphs.per.page	See generic tfplot method
par	See generic tfplot method
reset.screen	See generic tfplot method
...	other objects to plot (currently unused).

Details

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

diff returns an object in which the time series data has been differenced. tfplot returns an invisible value but is executed mainly for the side-effect (plot).

Author(s)

Paul Gilbert

See Also

TSFmodel, estTSF.ML, simulate.TSFmodel, tfplot, diff, factors, explained, factorNames, TSFmodel

tsfa documentation built on Jan. 13, 2021, 10:53 a.m.