update.seas: Update and Re-evaluate a Seasonal Adjustment Model

In seasonal: R Interface to X-13-ARIMA-SEATS

Update and Re-evaluate a Seasonal Adjustment Model

Description

Method to update and re-evaluate an object of class "seas".

Usage

## S3 method for class 'seas'
update(object, ..., evaluate = TRUE)

Arguments

object	an object of class "seas", usually, a result of a call to seas().
...	spec-argument options sent to X-13 (with the same syntax as in seas())
evaluate	logical. If TRUE, the call is evaluated.

Details

Contrary to the default method of update(), the "seas" method uses the evaluated call, rather than the actual call for re- evaluation. This means you can savely use it in other functions, which is useful with lapply() and friends (see examples.)

Value

Object of class "seas". Or an object of class "call" if evaluate = FALSE.

See Also

seas() for the main function.

static(), to return the (optionally evaluated) static call of a "seas" object.

Examples

# updating the call
m <- seas(AirPassengers)
update(m, x11 = "")
update(m, x = sqrt(AirPassengers), x11 = "")

# 'update' can be also used with lapply (or mapply)

# a list of time series
dta <- list(fdeaths = fdeaths, mdeaths = mdeaths)

# use 'seas' via lapply
ll <- lapply(dta, seas, x11 = "")

# use 'update' via lapply
lapply(ll, update, arima.model = c(0, 1, 1, 0, 1, 1))

seasonal documentation built on Oct. 20, 2024, 1:08 a.m.