jSA: Functions around 'jSA' objects

In RJDemetra: Interface to 'JDemetra+' Seasonal Adjustment Software

Functions around 'jSA' objects

Description

get_dictionary returns the indicators that can be extracted from "jSA" objects, get_indicators extracts a list of indicators jSA2R returns the corresponding "SA".

Usage

get_jspec(x, ...)

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	a userdefined vector containing the names of additional output variables (see user_defined_variables). Only used for "SA" objects.

Details

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

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

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

• "dictionary": the Java object containing the dictionary 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 seasonally adjusted ("SA" object) or RegARIMA ("regarima" object) model.

get_jspec returns the Java object that contains the specification of an object. Such object can be of type "jSA", "X13", "TRAMO_SEATS" or "sa_item".

Value

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

Examples

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

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

# To convert the Java object to an R object
jSA2R(mysa)

RJDemetra documentation built on Oct. 1, 2024, 5:07 p.m.