final
Time Series of a Seasonal Adjustment Model
Functions to extract the main time series from a "seas"
object. For
universal import of X-13ARIMA-SEATS tables, use the series
function.
Usage
final(object)original(object)
trend(object)
irregular(object)
# S3 method for seas
residuals(object, ...)
Arguments
- object
an object of class
"seas"
.- ...
not used. For compatibility with the generic.
Details
These functions support R default NA handling. If na.action =
na.exclude
is specified in the call to seas
, the time series will
also contain NAs.
Value
returns a "ts"
object, depending on the function.
References
Vignette with a more detailed description: http://www.seasonal.website/seasonal.html
Comprehensive list of R examples from the X-13ARIMA-SEATS manual: http://www.seasonal.website/examples.html
Official X-13ARIMA-SEATS manual: https://www.census.gov/ts/x13as/docX13ASHTML.pdf
See Also
seas
for the main function of seasonal.
series
, for universal X-13 output extraction.
Examples
# NOT RUN {
m <- seas(AirPassengers)
final(m)
original(m)
irregular(m)
trend(m)
# NA handling
AirPassengersNA <- window(AirPassengers, end = 1962, extend = TRUE)
final(seas(AirPassengersNA, na.action = na.omit)) # no NA in final series
final(seas(AirPassengersNA, na.action = na.exclude)) # NA in final series
final(seas(AirPassengersNA, na.action = na.x13)) # NA filled by x13
# final(seas(AirPassengersNA, na.action = na.fail)) # fails
# }