report {BETS}

Create dynamic reports with a full analysis of a set of time series

Description

Generate automatic reports with a complete analysis of a set of time series. For now, SARIMA (Box & Jenkins approach), Holt-Winters and GRNN analysis are possible. Soon, Multilayer Perceptron, Fuzzy Logic and Box-Cox analysis will become available.

Usage

report(mode = "SARIMA", ts = 21864, parameters = NULL, report.file = NA,
  series.saveas = "none")

Arguments

mode

A character.The type of the analysis. So far, 'SARIMA', 'GRNN' and 'HOLT-WINTERS' are available.

ts

A integer, a ts object or a list of integers and ts objects. Either the ID of the series in the BETS database or a time series object (any series, not just BETS's). If a list is provided, a report is generated for each series in this list, which can be mixed with IDs and time series objects.

parameters

A list. The parameters of the report. See the 'details' section for more information.

report.file

A character. A path and a name for the report file (an .html file). If there is more than one series, this name will be used as a prefix. If this parameter is not provided, the report will be saved inside the 'reports' folder, under the BETS installation directory.

series.saveas

A character. The format of the file on which the series and the predictions should be written. Possible values are 'none' (default), 'sas', 'dta', 'spss', 'csv', 'csv2' . Is is saved under the same directory as the report file.

Details

SARIMA Report Parameters

• cf.lags: An integer. Maximum number of lags to show on the ACFs e PACFs

• n.ahead: An integer. Prevision horizon (number of steps ahead)

• inf.crit: A character. Information criterion to be used in model selection.

• dummy: A ts object. A dummy regressor. Must also cover the forecasting period.

• ur.test: A list. Parameters of ur_test

• arch.test: A list. Parameters of arch_test

• box.test: A list. Parameters of Box.test

GRNN Report Parameters

• auto.reg: A boolean. Is the dependant variable auto-regressive?

• present.regs: A boolean Include non-lagged series among regressors?

• lag.max: A integer Regressors' maximum lag

• regs: A list. Regressors codes or time series

• start.train: Training set starting period

• end.train: Training set ending period

• start.test: Testing set starting period

• end.test: Testing set ending period

• sigma.interval: A numeric vector. Sigma inteval

• sigma.step: A numeric value. Sigma step

• var.names: A character vector. Variable names

HOLT-WINTERS Report Parameters

• alpha: Smooth factor of the level component. If numeric, it must be within the half-open unit interval (0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of alpha. It must not be FALSE or 0.

• beta: Smooth factor of the trend component. If numeric, it must be within the unit interval [0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of beta. The trend component is omitted if beta is FALSE or 0.

• gamma: Smooth factors of the seasonal component. If numeric, it must be within the unit interval [0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of gamma. The seasonal component will be omitted if gamma is FALSE or 0. This must be specified as FALSE if frequency(x) is not an integer greater than 1.

• additive: A single character string specifying how the seasonal component interacts with the other components. "additive", the default, means that x is modeled as level + trend + seasonal and "multiplicative" means the model is (level + trend) * seasonal. Abbreviations of "additive" and "multiplicative" are accepted.

• l.start: The starting value of the level component.

• b.start: The starting value of the trend component

• s.start: The starting values of seasonal component, a vector of length frequency(x)

• n.ahead: Prevision horizon (number of steps ahead)

For more information about these parameters, see also HoltWinters. Most parameters are the same and we just reproduced their documentation here.

Value

One or more .html files (the reports) and, optionally, data files (series plus predictions).

Author(s)

Talitha Speranza [e-mail]

Examples

##-- SARIMA

# parameters = list(lag.max = 48, n.ahead = 12 ) 
# report(ts = 21864, parameters = parameters)

# report(ts = 4447, series.saveas = "csv")

# series = list(BETSget(4447), BETSget(21864))
# parameters = list(lag.max = 20, n.ahead = 15 ) 
# report(ts = series, parameters = parameters)

# series = list(4447, 21864)
# report(ts = series, parameters = parameters)

# parameters = list( 
# cf.lags = 25,
# n.ahead = 15,
# dummy = dum,
# arch.test = list(lags = 12, alpha = 0.01),
# box.test = list(type = "Box-Pierce")
# )
# report(ts = window(BETSget(21864), start= c(2002,1) , end = c(2015,10)), 
#parameters = parameters)

# dum <- dummy(start= c(2002,1) , end = c(2017,1) , 
#from = c(2008,9) , to = c(2008,11))

# parameters = list( 
#    cf.lags = 25,
#    n.ahead = 15,
#    dummy = dum
# )

# report(ts = window(BETSget(21864), start= c(2002,1) , end = c(2015,10)), 
#parameters = parameters)


##-- GRNN

# params = list(regs = 4382)
# report(mode = "GRNN", ts = 13522, parameters = params)

##-- HOLT-WINTERS

# params = list(alpha = 0.5, gamma = TRUE)
# report(mode = "HOLT-WINTERS", ts = 21864, series.saveas = "csv", parameters = params)

# params = list(gamma = T, beta = TRUE)
# report(mode = "HOLT-WINTERS", ts = 21864, series.saveas = "csv", parameters = params)