user_defined_variables: Display a list of all the available output objects (series,...

View source: R/user_defined.R

user_defined_variablesR Documentation

Display a list of all the available output objects (series, parameters, diagnostics)

Description

Function generating a comprehensive list of available output variables (series, parameters, diagnostics) from the estimation process with x13 and tramoseats. Some items are available in the default estimation output but the remainder can be added using the userdefined parameter.

Usage

user_defined_variables(sa_object = c("X13-ARIMA", "TRAMO-SEATS"))

Arguments

sa_object

a character: "X13-ARIMA" to retrieve the additional output variables available for the X13-ARIMA method and "TRAMO-SEATS" for the TRAMO-SEATS method.

Value

a vector containing the names of all the available output objects (series, diagnostics, parameters)

References

More information and examples related to 'JDemetra+' features in the online documentation: https://jdemetra-new-documentation.netlify.app/

Examples

y<- ipi_c_eu[, "FR"]
user_defined_variables("X13-ARIMA")
m <- x13(y,"RSA5c", userdefined=c("b20","ycal","residuals.kurtosis" ))
m$user_defined$b20
m$user_defined$ycal
m$user_defined$residuals.kurtosis
user_defined_variables("TRAMO-SEATS")
m <- tramoseats(y,"RSAfull", userdefined=c("ycal","variancedecomposition.seasonality"))
m$user_defined$ycal
m$user_defined$variancedecomposition.seasonality


RJDemetra documentation built on Oct. 19, 2023, 1:12 a.m.