The series function imports all tables that can be saved in X-13ARIMA-SEATS.
series(x, series, reeval =TRUE, verbose =TRUE)
Arguments
x: an object of class "seas".
series: character vector, short or long names of an X-13ARIMA-SEATS table. If a long name is specified, it needs to be combined with the spec name and separated by a dot (it is not unique, otherwise. See list below.). More than one series can be specified (see examples).
reeval: logical, if TRUE, the model is re-evaluated with the corresponding specs enabled.
verbose: logical, if TRUE, a message is returned if a spec is added during reevaluation.
Returns
depending on the table, either an object of class "ts" or "data.frame".
Details
If the save argument is not specified in the model call, series
re-evaluates the call with the corresponding specs enabled (also returning a message). Note that re-evaluation doubles the overall computational time. If you want to accelerate the procedure, you have to be explicit about the output in the model call (see examples).
List of all importable tables from X-13ARIMA-SEATS:
spec
long name
short name
description
check
check.acf
acf
autocorrelation function of residuals with standard errors and Ljung-Box Q-statistics computed through each lag
check
check.acfsquared
ac2
autocorrelation function of squared residuals with standard errors and Ljung-Box Q-statistics computed through each lag
check
check.pacf
pcf
partial autocorrelation function of residuals with standard errors
composite
composite.adjcompositesrs
b1
aggregated time series data, prior adjusted, with associated dates
composite
composite.calendaradjcomposite
cac
aggregated time series data, adjusted for regARIMA calendar effects.
composite
composite.compositesrs
cms
aggregated time series data, with associated dates
composite
composite.indadjsatot
iaa
final indirect seasonally adjusted series, with yearly totals adjusted to match the original series
composite
composite.indadjustfac
iaf
final combined adjustment factors for the indirect seasonal adjustment
composite
composite.indaoutlier
iao
final indirect AO outliers
composite
composite.indcalendar
ica
final calendar factors for the indirect seasonal adjustment
composite
composite.indirregular
iir
final irregular component for the indirect adjustment
composite
composite.indlevelshift
ils
final indirect LS outliers
composite
composite.indmcdmovavg
if1
MCD moving average of the final indirect seasonally adjusted series
composite
composite.indmodirr
ie3
irregular component modified for extreme values from the indirect seasonal adjustment
composite
composite.indmodoriginal
ie1
original series modified for extreme values from the indirect seasonal adjustment
composite
composite.indmodsadj
ie2
seasonally adjusted series modified for extreme values from the indirect seasonal adjustment
composite
composite.indreplacsi
id9
final replacement values for extreme SI-ratios (differences) for the indirect adjustment
composite
composite.indrevsachanges
i6a
percent changes for indirect seasonally adjusted series with revised yearly totals
composite
composite.indrndsachanges
i6r
percent changes (differences) in the rounded indirect seasonally adjusted series
composite
composite.indrobustsa
iee
final indirect seasonally adjusted series modified for extreme values
composite
composite.indsachanges
ie6
percent changes (differences) in the indirect seasonally adjusted series
composite
composite.indsadjround
irn
rounded indirect seasonally adjusted series
composite
composite.indseasadj
isa
final indirect seasonally adjusted series
composite
composite.indseasonal
isf
final seasonal factors for the indirect seasonal adjustment
composite
composite.indseasonaldiff
isd
final seasonal difference for the indirect seasonal adjustment (only for pseudo-additive seasonal adjustment)
composite
composite.indtotaladjustment
ita
total indirect adjustment factors (only produced if the original series contains values that are <= 0)
composite
composite.indtrend
itn
final trend-cycle for the indirect adjustment
composite
composite.indtrendchanges
ie7
percent changes (differences) in the indirect final trend component
composite
composite.indunmodsi
id8
final unmodified SI-ratios (differences) for the indirect adjustment
composite
composite.origchanges
ie5
percent changes (differences) in the original series
composite
composite.outlieradjcomposite
oac
aggregated time series data, adjusted for outliers.
composite
composite.prioradjcomposite
ia3
composite series adjusted for user-defined prior adjustments applied at the component level
estimate
estimate.armacmatrix
acm
correlation matrix of ARMA parameter estimates if used with the print argument; covariance matrix of same if used with the save argument
estimate
estimate.iterations
itr
detailed output for estimation iterations, including log-likelihood values and parameters, and counts of function evaluations and iterations
estimate
estimate.regcmatrix
rcm
correlation matrix of regression parameter estimates if used with the print argument; covariance matrix of same if used with the save argument
estimate
estimate.regressioneffects
ref
Xb matrix of regression variables multiplied by the vector of estimated regression coefficients
estimate
estimate.residuals
rsd
model residuals with associated dates or observation numbers
estimate
estimate.roots
rts
roots of the autoregressive and moving average operators in the estimated model
force
force.forcefactor
ffc
factors applied to get seasonally adjusted series with constrained yearly totals (if type = regress or type = denton)
force
force.revsachanges
e6a
percent changes (differences) in seasonally adjusted series with revised yearly totals
force
force.revsachangespct
p6a
percent changes in seasonally adjusted series with forced yearly totals
force
force.rndsachanges
e6r
percent changes (differences) in rounded seasonally adjusted series
force
force.rndsachangespct
p6r
percent changes in rounded seasonally adjusted series
force
force.saround
rnd
rounded final seasonally adjusted series (if round = yes) or the rounded final seasonally adjusted series with constrained yearly totals (if type = regress or type = denton)
force
force.seasadjtot
saa
final seasonally adjusted series with constrained yearly totals (if type = regress or type = denton)
forecast
forecast.backcasts
bct
point backcasts on the original scale, along with upper and lower prediction interval limits
forecast
forecast.forecasts
fct
point forecasts on the original scale, along with upper and lower prediction interval limits
forecast
forecast.transformed
ftr
forecasts on the transformed scale, with corresponding forecast standard errors
forecast
forecast.transformedbcst
btr
backcasts on the transformed scale, with corresponding forecast standard errors
forecast
forecast.variances
fvr
forecast error variances on the transformed scale, showing the contributions of the error assuming the model is completely known (stochastic variance) and the error due to estimating any regression parameters (error in estimating AR and MA parameters is ignored)
history
history.armahistory
amh
history of estimated AR and MA coefficients from the regARIMA model
history
history.chngestimates
che
concurrent and most recent estimate of the month-tomonth (or quarter-to-quarter) changes in the seasonally adjusted data
history
history.chngrevisions
chr
revision from concurrent to most recent estimate of the month-to-month (or quarter-to-quarter) changes in the seasonally adjusted data
history
history.fcsterrors
fce
revision history of the accumulated sum of squared forecast errors
history
history.fcsthistory
fch
listing of the forecast and forecast errors used to generate accumulated sum of squared forecast errors
history
history.indsaestimates
iae
concurrent and most recent estimate of the indirect seasonally adjusted data
history
history.indsarevisions
iar
revision from concurrent to most recent estimate of the indirect seasonally adjusted series
history
history.lkhdhistory
lkh
history of AICC and likelihood values
history
history.outlierhistory
rot
record of outliers removed and kept for the revisions history (printed only if automatic outlier identification is used)
history
history.saestimates
sae
concurrent and most recent estimate of the seasonally adjusted data
history
history.sarevisions
sar
revision from concurrent to most recent estimate of the seasonally adjusted data
history
history.seatsmdlhistory
smh
SEATS ARIMA model history
history
history.sfestimates
sfe
concurrent and most recent estimate of the seasonal factors and projected seasonal factors
history
history.sfilterhistory
sfh
record of seasonal filter selection for each observation in the revisions history (printed only if automatic seasonal filter selection is used)
history
history.sfrevisions
sfr
revision from concurrent to most recent estimate of the seasonal factor, as well as projected seasonal factors
history
history.tdhistory
tdh
history of estimated trading day regression coefficients from the regARIMA model
history
history.trendchngestimates
tce
concurrent and most recent estimate of the month-tomonth (or quarter-to-quarter) changes in the trend component
history
history.trendchngrevisions
tcr
revision from concurrent to most recent estimate of the month-to-month (or quarter-to-quarter) changes in the trend component
history
history.trendestimates
tre
concurrent and most recent estimate of the trend component
history
history.trendrevisions
trr
revision from concurrent to most recent estimate of the trend component
identify
identify.acf
iac
sample autocorrelation function(s), with standard errors and Ljung-Box Q-statistics for each lag
identify
identify.pacf
ipc
sample partial autocorrelation function(s) with standard errors for each lag
outlier
outlier.finaltests
fts
t-statistics for every time point and outlier type generated during the final outlier detection iteration (not saved when automdl/pickmdl is used)
outlier
outlier.iterations
oit
detailed results for each iteration of outlier detection including outliers detected, outliers deleted, model parameter estimates, and robust and nonrobust estimates of the residual standard deviation
final irregular component adjusted for point outliers
x11
x11.irregularb
b13
irregular component, B iteration
x11
x11.irregularc
c13
irregular component, C iteration
x11
x11.irregularpct
pir
final irregular component, expressed as percentages if appropriate
x11
x11.irrwt
c17
final weights for the irregular component
x11
x11.irrwtb
b17
preliminary weights for the irregular component
x11
x11.mcdmovavg
f1
MCD moving average of the final seasonally adjusted series
x11
x11.modirregular
e3
irregular component modified for zero-weighted extreme values
x11
x11.modoriginal
e1
original series modified for zero-weighted extreme values
x11
x11.modseasadj
e2
seasonally adjusted series modified for zero-weighted extreme values
x11
x11.modsic4
c4
modified SI-ratios (differences), C iteration
x11
x11.modsid4
d4
modified SI-ratios (differences), D iteration
x11
x11.origchanges
e5
percent changes (differences) in original series
x11
x11.origchangespct
pe5
percent changes in the original series
x11
x11.replacsi
d9
final replacement values for extreme SI-ratios (differences), D iteration
x11
x11.replacsic9
c9
modified SI-ratios (differences), C iteration
x11
x11.robustsa
e11
robust final seasonally adjusted series
x11
x11.sachanges
e6
percent changes (differences) in seasonally adjusted series
x11
x11.sachangespct
pe6
percent changes in seasonally adjusted series
x11
x11.seasadj
d11
final seasonally adjusted series
x11
x11.seasadjb11
b11
seasonally adjusted series, B iteration
x11
x11.seasadjb6
b6
preliminary seasonally adjusted series, B iteration
x11
x11.seasadjc11
c11
seasonally adjusted series, C iteration
x11
x11.seasadjc6
c6
preliminary seasonally adjusted series, C iteration
x11
x11.seasadjconst
sac
final seasonally adjusted series with constant from transform spec included
x11
x11.seasadjd6
d6
preliminary seasonally adjusted series, D iteration
x11
x11.seasonal
d10
final seasonal factors
x11
x11.seasonaladjregsea
ars
seasonal factors adjusted for user-defined seasonal regARIMA component
x11
x11.seasonalb10
b10
seasonal factors, B iteration
x11
x11.seasonalb5
b5
preliminary seasonal factors, B iteration
x11
x11.seasonalc10
c10
preliminary seasonal factors, C iteration
x11
x11.seasonalc5
c5
preliminary seasonal factors, C iteration
x11
x11.seasonald5
d5
preliminary seasonal factors, D iteration
x11
x11.seasonaldiff
fsd
final seasonal difference (only for pseudo-additive seasonal adjustment)
x11
x11.seasonalpct
psf
final seasonal factors, expressed as percentages if appropriate
x11
x11.sib3
b3
preliminary unmodified SI-ratios (differences)
x11
x11.sib8
b8
unmodified SI-ratios (differences)
x11
x11.tdadjorig
c19
original series adjusted for final trading day
x11
x11.tdadjorigb
b19
original series adjusted for preliminary trading day
x11
x11.totaladjustment
tad
total adjustment factors (only printed out if the original series contains values that are <= 0)
x11
x11.trend
d12
final trend-cycle
x11
x11.trendadjls
tal
final trend-cycle adjusted for level shift outliers
x11
x11.trendb2
b2
preliminary trend-cycle, B iteration
x11
x11.trendb7
b7
preliminary trend-cycle, B iteration
x11
x11.trendc2
c2
preliminary trend-cycle, C iteration
x11
x11.trendc7
c7
preliminary trend-cycle, C iteration
x11
x11.trendchanges
e7
percent changes (differences) in final trend component series
x11
x11.trendchangespct
pe7
percent changes in final trend cycle
x11
x11.trendconst
tac
final trend component with constant from transform spec included
x11
x11.trendd2
d2
preliminary trend-cycle, D iteration
x11
x11.trendd7
d7
preliminary trend-cycle, D iteration
x11
x11.unmodsi
d8
final unmodified SI-ratios (differences)
x11
x11.unmodsiox
d8b
final unmodified SI-ratios, with labels for outliers and extreme values
x11
x11.yrtotals
e4
ratio of yearly totals of original and seasonally adjusted series
x11regression
x11regression.calendar
xca
final calendar factors (trading day and holiday)
x11regression
x11regression.calendarb
bxc
preliminary calendar factors
x11regression
x11regression.combcalendar
xcc
final calendar factors from combined daily weights
x11regression
x11regression.combcalendarb
bcc
preliminary calendar factors from combined daily weights
x11regression
x11regression.combtradingday
c18
final trading day factors from combined daily weights
x11regression
x11regression.combtradingdayb
b18
preliminary trading day factors from combined daily weights
x11regression
x11regression.extremeval
c14
irregulars excluded from the irregular regression, C iteration
x11regression
x11regression.extremevalb
b14
irregulars excluded from the irregular regression, B iteration
x11regression
x11regression.holiday
xhl
final holiday factors
x11regression
x11regression.holidayb
bxh
preliminary holiday factors
x11regression
x11regression.outlieriter
xoi
detailed results for each iteration of outlier detection including outliers detected, outliers deleted, model parameter estimates, and robust and non-robust estimates of the residual standard deviation
x11regression
x11regression.priortd
a4
prior trading day weights and factors
x11regression
x11regression.tradingday
c16
final trading day factors and weights
x11regression
x11regression.tradingdayb
b16
preliminary trading day factors and weights
x11regression
x11regression.x11reg
c15
final irregular regression coefficients and diagnostics
x11regression
x11regression.x11regb
b15
preliminary irregular regression coefficients and diagnostics
x11regression
x11regression.xregressioncmatrix
xrc
correlation matrix of irregular regression parameter estimates if used with the print argument; covariance matrix of same if used with the save argument
x11regression
x11regression.xregressionmatrix
xrm
values of irregular regression variables with associated dates
Examples
m <- seas(AirPassengers)series(m,"fct")# re-evaluate with the forecast spec activated# more than one seriesseries(m, c("rsd","fct"))m <- seas(AirPassengers, forecast.save ="fct")series(m,"fct")# no re-evaluation (much faster!)# using long namesseries(m,"forecast.forecasts")# history specseries(m,"history.trendestimates")series(m,"history.sfestimates")series(m,"history.saestimates")series(m, c("history.sfestimates","history.trendestimates"))# slidingspans specseries(m,"slidingspans.sfspans")series(m,"slidingspans.ychngspans")# fundamental identities of seasonal adjustment# Y = T * I * (S * TD)all.equal(AirPassengers, series(m,"seats.trend")* series(m,"seats.irregular")* series(m,"seats.adjustfac"))# Y_sa = Y / (S * TD)all.equal(final(m), AirPassengers / series(m,"seats.adjustfac"))### Some X-13ARIMA-SEATS functions can be replicated in R:# X-13ARIMA-SEATS spectrumplot(series(m,"spectrum.specorig")[,-1], t ="l")# R equivalent: spectrum from statsspectrum(diff(log(AirPassengers)), method ="ar")# X-13ARIMA-SEATS pacfx13.pacf <- series(m,"identify.pacf")plot(x13.pacf[,1], t ="h")lines(x13.pacf[,2])lines(-x13.pacf[,2])# R equivalent: pacf from statspacf(AirPassengers, lag.max =35)# use with composite (see vignette("multiple", "seasonal"))m_composite <- seas( cbind(mdeaths, fdeaths), composite = list(), series.comptype ="add")series(m_composite,"composite.indseasadj")