yth_glm: Fits Hamilton's alternative model

View source: R/yth_glm.R

yth_glmR Documentation

Fits Hamilton's alternative model

Description

yth_glm fits a generalized linear model suggested by James D. Hamilton as a better alternative to the Hodrick-Prescott Filter.

Usage

yth_glm(x, h = 8, p = 4, ...)

Arguments

x

A univariate xts object of any zoo index class, such as Date, yearmon, or yearqtr. For converting objects of type timeSeries, ts, irts, fts, matrix, data.frame, or zoo to xts, please see as.xts.

h

An integer, defining the lookahead period. Defaults to h = 8, suggested by Hamilton. The default assumes economic data of quarterly periodicity with a lookahead period of 2 years. This function is not limited by the default parameter, and econometricians may change it as required.

p

An integer, indicating the number of lags. A default of p = 4, suggested by Hamilton, assumes data is of quarterly periodicity. If data is monthly, one may choose p = 12 or aggregate the series to quarterly and maintain the default. Econometricians should use this parameter to accommodate the seasonality of their data.

...

Additional arguments passed to glm.

Details

For time series of quarterly periodicity, Hamilton suggests parameters of h = 8 and p = 4, or an AR(4) process, additionally lagged by 8 lookahead periods. Econometricians may explore variations of h. However, p is designed to correspond with the seasonality of a given periodicity and should be matched accordingly.

Value

yth_glm returns a generalized linear model object of class glm, which inherits from lm.

References

James D. Hamilton. Why You Should Never Use the Hodrick-Prescott Filter. NBER Working Paper No. 23429, Issued in May 2017.

See Also

glm, lm

Examples

data(GDPC1)

gdp_model <- yth_glm(GDPC1, h = 8, p = 4, family = gaussian)

summary(gdp_model)

plot(gdp_model)


neverhpfilter documentation built on Aug. 21, 2025, 5:59 p.m.