hanaml.AutoArima {hana.ml.r}R Documentation

AutoArima

Description

hanaml.AutoArima is a R wrapper for PAL Auto Arima algorithm.

Usage

hanaml.AutoArima(conn.context,
                 data,
                 endog = NULL,
                 exog = NULL,
                 seasonal.period = NULL,
                 seasonality.criterion = NULL,
                 d = NULL,
                 kpss.significance.level = NULL,
                 max.d = NULL,
                 seasonal.d = NULL,
                 ch.significance.level = NULL,
                 max.seasonal.d = NULL,
                 max.p = NULL,
                 max.q = NULL,
                 max.seasonal.p = NULL,
                 max.seasonal.q = NULL,
                 information.criterion = NULL,
                 search.strategy = NULL,
                 max.order = NULL,
                 initial.p = NULL,
                 initial.q = NULL,
                 initial.seasonal.p = NULL,
                 initial.seasonal.q = NULL,
                 guess.states = NULL,
                 max.search.iterations = NULL,
                 method = NULL,
                 allow.linear = NULL,
                 forecast.method = NULL,
                 output.fitted = NULL,
                 thread.ratio = NULL)

Arguments

conn.context

ConnectionContext
The connection to the SAP HANA system.

data

DataFrame
DataFrame containing the data.

endog

character, optional
The endogenous variable, i.e. time series. cannot be the first column's name (ID column).
Defaults to the second column's name.

exog

list of character, optional
An optional array of exogenous variables. Valid only for ARIMAX; cannot be the ID column's name and the name of endog column.
Defaults to None.

seasonal.period

integer, optional
Value of the seasonal period.
Negative: Automatically identify seasonality by means of auto-correlation scheme.
0 or 1: Non-seasonal.
Others: Seasonal period.
Defaults to -1.

seasonality.criterion

double, optional
The criterion of the auto-correlation coefficient for accepting seasonality, in the range of (0, 1). The larger it is, the less probable a time series is regarded to be seasonal.
Valid only when seasonal_period is negative.
Defaults to 0.2.

d

integer, optional
Order of first-differencing.
Others: Uses the specified value as the first-differencing order.
Negative: Automatically identifies first-differencing order with KPSS test.
Defaults to -1.

kpss.significance.level

double, optional
The significance level for KPSS test. Supported values are 0.01, 0.025, 0.05, and 0.1. The smaller it is, the larger probable a time series is considered as first-stationary, that is, the less probable it needs first-differencing. Valid only when d is negative. Defaults to 0.05.

max.d

integer, optional
The maximum value of d when KPSS test is applied. Defaults to 2.

seasonal.d

integer, optional
Order of seasonal-differencing. Negative: Automatically identifies seasonal-differencing order Canova-Hansen test. Others: Uses the specified value as the seasonal-differencing order. Defaults to -1.

ch.significance.level

double, optional
The significance level for Canova-Hansen test. Supported values are 0.01, 0.025, 0.05, 0.1, and 0.2. The smaller it is, the larger probable a time series is considered seasonal-stationary,that is, the less probable it needs seasonal-differencing.
Valid only when seasonal_d is negative. Defaults to 0.05.

max.seasonal.d

integer, optional
The maximum value of “seasonal_d“ when Canova-Hansen test is applied.
Defaults to 1.

max.p

integer, optional
The maximum value of AR order p.
Defaults to 5.

max.q

integer, optional
The maximum value of MA order q.
Defaults to 5.

max.seasonal.p

integer, optional
The maximum value of SAR order P.
Defaults to 2.

max.seasonal.q

integer, optional
The maximum value of SMA order Q.
Defaults to 2.

information.criterion

integer, optional
The information criterion for order selection:
0: AICC
1: AIC
2: BIC.
Defaults to 0.

search.strategy

integer, optional
The search strategy for optimal ARMA model.
0: Exhaustive traverse
1: Stepwise traverse.
Defaults to 1.

max.order

integer, optional
The maximum value of max.p + max.q + max.seasonal.p + max.seasonal.q. Valid only when search.strategy is 0.
Defaults to 15.

initial.p

integer, optional
Initial value of p. Valid only when search.strategy is 1.
Defaults to 0.

initial.q

integer, optional
Initial value of q. Valid only when search.strategy is 1.
Defaults to 0.

initial.seasonal.p

integer, optional
Initial value of seasonal.p.
Valid only when search.strategy is 1.
Defaults to 0.

initial.seasonal.q

integer, optional
Initial value of seasonal.q.
Valid only when search.strategy is 1.
Defaults to 0.

guess.states

integer, optional
If employing ACF/PACF to guess initial ARMA models, besides user-defined model:
0: No guess. Besides user-defined model, uses states (2, 2) (1, 1)m, (1, 0) (1, 0)m, and (0, 1) (0, 1)m meanwhile as starting states.
1: Guesses starting states taking advantage of ACF/PACF.
Valid only when search.strategy is 1.
Defaults to 1.

max.search.iterations

integer, optional
The maximum iterations for searching optimal ARMA states.
Valid only when emphsearch.strategy is 1.
Defaults to (max.p + 1) * (max.q + 1) * (max.seasonal.p + 1) * (max.seasonal.q + 1).

method

{"css", "mle", "css-mle"}, optional
The object function for numeric optimization.

  • "css": use the conditional sum of squares.

  • "mle": use the maximized likelihood estimation.

  • "css-mle": use css to approximate starting values and mle to fit.


Defaults to "css-mle".

allow.linear

integer, optional
Controls whether to check linear model ARMA (0, 0) (0, 0)m.
0: No
1: Yes
Defaults to 1.

forecast.method

{"formula.forecast", "innovations.algorithm"}, optional
Store information for the subsequent forecast method.

  • "formula.forecast": compute future series via formula.

  • "innovations.algorithm": apply innovations algorithm to compute future series, which requires more original information to be stored


Defaults to "innovations.algorithm".

output.fitted

logical, optional
Output fitted result and residuals if TRUE.
Defaults to TRUE.

thread.ratio

double, optional
Controls the proportion of available threads to use for prediction. The value range is from 0 to 1, where 0 indicates a single thread, and 1 indicates up to all available threads. Values between 0 and 1 will use that percentage of available threads.Values outside this range are ignored.
Defaults to 0.

Format

R6Class object.

Details

The AUTO ARIMA function identifies the orders of an ARIMA model (p, d, q)(P, D, Q)m, where m is the seasonal period according to some information criterion such as AICc, AIC, and BIC. If order selection succeeds, the function gives the optimal model as in the ARIMATRAIN function.

Value

#'

See Also

predict.AutoArima

Examples

## Not run: 
Input DataFrame data:
> data$Collect()
  TIMESTAMP       Y
1         1 -24.525
2         2  34.720
3         3  57.325
4         4  10.340
5         5 -12.890
......
Invoke hanaml.AutoArima():
  autoarima <- hanaml.AutoArima(conn,
                                data=data,
                                search.strategy=1)
Output:
> autoarima$fitted
    TIMESTAMP      FITTED   RESIDUALS
1           1          NA          NA
2           2          NA          NA
3           3          NA          NA
4           4          NA          NA
5           5 -24.5250000 11.63500000
6           6  37.5839311  1.46106885
7           7  57.9926243 -0.69262431
8           8   8.6228706 -1.88787060
9           9 -20.3259208  0.96092077

## End(Not run)

[Package hana.ml.r version 1.0.8 Index]