RJDemetra (version 0.1.3)

jSA: Functions around 'jSA' objects

Description

get_dictionary returns the indicators that can be extracted from "jSA" objects, get_indicators extract a list of indicators and "jSA2R" returns returns the corresponding "SA" or a "regarima" object.

Usage

get_dictionary(x)
get_indicators(x, ...)
jSA2R(x, userdefined = NULL)

Arguments

x

a "jSA" object.

...

characters containing the names of the indicators to extract.

userdefined

userdefined vector with characters for additional output variables (see user_defined_variables). Only used for "SA" objects.

Value

get_dictionary a vector of characters, get_indicators returns a list containing the indicators that are extracted and jSA2R returns a "SA" or a "regarima" object.

Details

A "jSA" object is a list with three elements:

• "result": the Java object with the results of a seasonal adjustment or a pre-adjustment method.

• "spec": the Java object with the specification of a seasonal adjustment or a pre-adjustment method.

• "dictionary": the Java object with dictionnary of a seasonal adjustment or a pre-adjustment method. In particular, it contains all the user-defined regressors.

get_dictionary returns the list of indicators that can be extracted from a jSA object by the function get_indicators.

jSA2R returns the corresponding formatted seasonal adjustment ("SA" object) or RegARIMA ("regarima" object) model.

Examples

# NOT RUN {
myseries <- ipi_c_eu[, "FR"]
mysa <- jx13(myseries, spec = "RSA5c")
get_dictionary(mysa)

get_indicators(mysa, "decomposition.b2", "decomposition.d10")

# To convert to the R object
jSA2R(mysa)
# }