isat: Indicator Saturation
In gets: General-to-Specific (GETS) Modelling and Indicator Saturation Methods

View source: R/gets-base-source.R

isat	R Documentation

Indicator Saturation

Description

The isat function undertakes multi-path indicator saturation to detect outliers and mean-shifts using impulses (IIS), step-shifts (SIS), or trend-indicators (TIS). Indicators are partitioned into blocks and selected over at a chosen level of significance (t.pval) using the getsm function.

Usage

isat(y, ...)

##default S3 method:
## Default S3 method:
isat(y, mc=TRUE, ar=NULL, ewma=NULL, mxreg=NULL, iis=FALSE, sis=TRUE,
  tis=FALSE, uis=FALSE, blocks=NULL, ratio.threshold=0.8, max.block.size=30,
  t.pval=0.001, wald.pval=t.pval,
  vcov.type= c("ordinary","white","newey-west"), do.pet=FALSE, ar.LjungB=NULL,
  arch.LjungB=NULL, normality.JarqueB=NULL, info.method=c("sc","aic","hq"),
  user.diagnostics=NULL, user.estimator=NULL, gof.function=NULL,
  gof.method = c("min", "max"), include.gum=NULL, include.1cut=FALSE,
  include.empty=FALSE, max.paths=NULL, parallel.options=NULL, turbo=FALSE,
  tol=1e-07, LAPACK=FALSE, max.regs=NULL, print.searchinfo=TRUE, plot=NULL,
  alarm=FALSE, ...)
  
##S3 method for objects of class 'lm':
## S3 method for class 'lm'
isat(y, ar=NULL, ewma=NULL, iis=FALSE, sis=TRUE,
  tis=FALSE, uis=FALSE, blocks=NULL, ratio.threshold=0.8, max.block.size=30,
  t.pval=0.001, wald.pval=t.pval,
  vcov.type= c("ordinary","white","newey-west"), do.pet=FALSE, ar.LjungB=NULL,
  arch.LjungB=NULL, normality.JarqueB=NULL, info.method=c("sc","aic","hq"),
  user.diagnostics=NULL, user.estimator=NULL, gof.function=NULL,
  gof.method = c("min", "max"), include.gum=NULL, include.1cut=FALSE,
  include.empty=FALSE, max.paths=NULL, parallel.options=NULL, turbo=FALSE,
  tol=1e-07, LAPACK=FALSE, max.regs=NULL, print.searchinfo=TRUE, plot=NULL,
  alarm=FALSE, ...)

##S3 method for objects of class 'arx':
## S3 method for class 'arx'
isat(y, mc=TRUE, ar=NULL, ewma=NULL, iis=FALSE, sis=TRUE,
  tis=FALSE, uis=FALSE, blocks=NULL, ratio.threshold=0.8, max.block.size=30,
  t.pval=0.001, wald.pval=t.pval,
  vcov.type= c("ordinary","white","newey-west"), do.pet=FALSE, ar.LjungB=NULL,
  arch.LjungB=NULL, normality.JarqueB=NULL, info.method=c("sc","aic","hq"),
  user.diagnostics=NULL, user.estimator=NULL, gof.function=NULL,
  gof.method = c("min", "max"), include.gum=NULL, include.1cut=FALSE,
  include.empty=FALSE, max.paths=NULL, parallel.options=NULL, turbo=FALSE,
  tol=1e-07, LAPACK=FALSE, max.regs=NULL, print.searchinfo=TRUE, plot=NULL,
  alarm=FALSE, ...)

Arguments

`y`	numeric vector, time-series, `zoo`, or object of class `lm` or `arx`. Missing values in the beginning and at the end of the series is allowed, as they are removed with the `na.trim` command
`mc`	logical. `TRUE` (default) includes an intercept in the mean specification, whereas FALSE does not
`ar`	integer vector, say, c(2,4) or 1:4. The AR-lags to include in the mean specification
`ewma`	either NULL (default) or a list with arguments sent to the `eqwma` function. In the latter case a lagged moving average of y is included as a regressor
`mxreg`	numeric vector or matrix, say, a `zoo` object, of conditioning variables. Note that missing values in the beginning or at the end of the series is allowed, as they are removed with the `na.trim` command. Note also that, if both `y` and `mxreg` are `zoo` objects, then their samples are chosen to match
`iis`	logical. If `TRUE`, impulse indicator saturation is performed.
`sis`	logical. If `TRUE`, step indicator saturation is performed.
`tis`	logical. If `TRUE`, trend indicator saturation is performed.
`uis`	a matrix of regressors, or a list of matrices.
`blocks`	`NULL` (default), an integer (the number of blocks) or a user-specified `list` that indicates how blocks should be put together. If `NULL`, then the number of blocks is determined automatically
`ratio.threshold`	Minimum ratio of variables in each block to total observations to determine the block size, default=0.8. Only relevant if blocks = `NULL`
`max.block.size`	Maximum size of block of variables to be selected over, default=30. Block size used is the maximum of given by either the ratio.threshold and max.block.size
`t.pval`	numeric value between 0 and 1. The significance level used for the two-sided regressor significance t-tests
`wald.pval`	numeric value between 0 and 1. The significance level used for the Parsimonious Encompassing Tests (PETs)
`vcov.type`	the type of variance-covariance matrix used. If NULL (default), then the type used is that of the 'arx' object. This can be overridden by either "ordinary" (i.e. the ordinary variance-covariance matrix) or "white" (i.e. the White (1980) heteroscedasticity robust variance-covariance matrix)
`do.pet`	logical. If `TRUE`, then a Parsimonious Encompassing Test (PET) against the GUM is undertaken at each regressor removal for the joint significance of all the deleted regressors along the current path. If FALSE (default), then a PET is not undertaken at each regressor removal. By default, the numeric value is the same as that of `t.pval`
`ar.LjungB`	a two-item list with names `lag` and `pval`, or NULL (default). In the former case `lag` contains the order of the Ljung and Box (1979) test for serial correlation in the standardised residuals, and `pval` contains the significance level. If `lag=NULL` (default), then the order used is that of the estimated 'arx' object. If `ar.Ljungb=NULL`, then the standardised residuals are not checked for serial correlation
`arch.LjungB`	a two-item list with names `lag` and `pval`, or NULL (default). In the former case, `lag` contains the order of the Ljung and Box (1979) test for serial correlation in the squared standardised residuals, and `pval` contains the significance level. If `lag=NULL` (default), then the order used is that of the estimated 'arx' object. If `arch.Ljungb=NULL`, then the standardised residuals are not checked for ARCH
`normality.JarqueB`	`NULL` (the default) or a value between 0 and 1. In the latter case, a test for non-normality is conducted using a significance level equal to `normality.JarqueB`. If `NULL`, then no test for non-normality is conducted
`info.method`	character string, "sc" (default), "aic" or "hq", which determines the information criterion to be used when selecting among terminal models. The abbreviations are short for the Schwarz or Bayesian information criterion (sc), the Akaike information criterion (aic) and the Hannan-Quinn (hq) information criterion
`user.diagnostics`	`NULL` or a `list` with two entries, `name` and `pval`, see the `user.fun` argument in `diagnostics`
`user.estimator`	`NULL` or a `list` with at least one entry, `name`, see the `user.estimator` argument in `getsFun`
`gof.function`	`NULL` or a `list` with at least one entry, `name`, see the `user.estimator` argument in `getsFun`
`gof.method`	`NULL` or a `character` that determines whether the best Goodness-of-Fit is a minimum or maximum
`include.gum`	ignored (temporarily deprecated)
`include.1cut`	logical. If `TRUE`, then the 1-cut model is included among the terminal models, if it passes the diagnostic tests, even if it is not equal to one of the terminals. If FALSE (default), then the 1-cut model is not included (unless it is one of the terminals)
`include.empty`	logical. If `TRUE`, then an empty model is included among the terminal models, if it passes the diagnostic tests, even if it is not equal to one of the terminals. If FALSE (default), then the empty model is not included (unless it is one of the terminals)
`max.paths`	`NULL` (default) or an integer indicating the maximum number of paths to search
`parallel.options`	`NULL` or an integer, i.e. the number of cores/threads to be used for parallel computing (implemented w/`makeCluster` and `parLapply`)
`turbo`	logical. If `TRUE`, then (parts of) paths are not searched twice (or more) unnecessarily, thus yielding a significant potential for speed-gain. However, the checking of whether the search has arrived at a point it has already been comes with a slight computational overhead. Accordingly, if `turbo=TRUE`, then the total search time might in fact be higher than if `turbo=FALSE`. This happens if estimation is very fast, say, less than quarter of a second. Hence the default is `FALSE`
`tol`	numeric value (default = 1e-07). The tolerance for detecting linear dependencies in the columns of the regressors (see `qr` function). Only used if LAPACK is FALSE (default)
`LAPACK`	logical. If `TRUE`, then use LAPACK. If `FALSE` (default), then use LINPACK (see `qr` function)
`max.regs`	integer. The maximum number of regressions along a deletion path. It is not recommended that this is altered
`print.searchinfo`	logical. If `TRUE` (default), then a print is returned whenever simiplification along a new path is started, and whenever regressors are dropped due to exact multicolinearity
`plot`	NULL or logical. If `TRUE`, then the fitted values and the residuals of the final model are plotted after model selection. If NULL (default), then the value set by `options` determines whether a plot is produced or not.
`alarm`	logical. If `TRUE`, then a sound is emitted (in order to alert the user) when the model selection ends
`...`	further arguments passed to or from other methods

Details

Multi-path indicator saturation using impulses (IIS), step-shifts (SIS), or trend-indicators (TIS). Indicators are partitioned into sequential blocks (as of beta version 0.7) where the block intervals are defined by the ratio of variables to observations in each block and a specified maximum block size. Indicators are selected over using the getsm function. Retained indicators in each block are combined and re-selected over. Fixed covariates that are not selected over can be included in the regression model either in the mxreg matrix, or for auto-regressive terms through the ar specification. See Hendry, Johansen and Santos (2007) and Castle, Doornik, Hendry, and Pretis (2015)

Value

A list of class 'isat'

Author(s)

Jonas Kurle, https://www.jonaskurle.com/
Felix Pretis, http://www.felixpretis.org/
James Reade, https://sites.google.com/site/jjamesreade/
Moritz Schwarz, https://www.inet.ox.ac.uk/people/moritz-schwarz/
Genaro Sucarrat http://www.sucarrat.net/

References

Castle, Jennifer, L., Doornik, Jurgen, A., Hendry, David F., and Pretis, Felix (2015): 'Detecting Location Shifts during Model Selection by Step-Indicator Saturation', Econometrics, vol 3:2, 240-264.

Hendry, David, F., Johansen, Soren, and Santos, Carlos (2007): 'Automatic selection of indicators in a fully saturated regression'. Computational Statistics, vol 23:1, pp.317-335.

Pretis, Felix, Reade, James and Sucarrat, Genaro (2018): 'Automated General-to-Specific (GETS) Regression Modeling and Indicator Saturation for Outliers and Structural Breaks'. Journal of Statistical Software 86, Number 3, pp. 1-44

Examples

##SIS using the Nile data
data(Nile)
isat(Nile, sis=TRUE, iis=FALSE, plot=TRUE, t.pval=0.005)

##SIS using the Nile data in an autoregressive model
#isat(Nile, ar=1:2, sis=TRUE, iis=FALSE, plot=TRUE, t.pval=0.005)

##HP Data
##load Hoover and Perez (1999) data:
#data(hpdata)

##make quarterly data-matrix of zoo type
##(GCQ = personal consumption expenditure):
#y <- zooreg(hpdata$GCQ, 1959, frequency=4)

##transform data to log-differences:
#dlogy <- diff(log(y))

##run isat with step impulse saturation on four
##lags and a constant 1 percent significance level:
#isat(dlogy, ar=1:4, sis=TRUE, t.pval =0.01)

##Example with additional covariates entering through mxreg:

##(GYDQ = disposable personal income):
#x <- zooreg(hpdata$GYDQ, 1959, frequency=4)

##transform data to log-differences:
#dlogx <- diff(log(x))

##run isat with step impulse saturation on four
##lags and a constant 1 percent significance level:
#isat(dlogy, mxreg=dlogx, ar=1:4, sis=TRUE, t.pval =0.01)

gets documentation built on Oct. 10, 2022, 1:06 a.m.