summary.dfl_decompose: summary method for class "dfl_decompose"

In ddecompose: Detailed Distributional Decomposition

summary method for class "dfl_decompose"

Description

summary method for class "dfl_decompose"

Usage

## S3 method for class 'dfl_decompose'
summary(object, ..., confidence_level = 0.95, digits = 4)

Arguments

object	an object of class "dfl_decompose", a result of a call to [dfl_decompose()].
...	other parameters to be passed through to printing functions.
confidence_level	numeric value between 0 and 1 (default = 0.95) that defines the confidence level of the printed confidence intervals.
digits	number of digits to be printed.

Details

If standard errors were bootstrapped, standard errors and confidence bands are given. Pointwise confidences bands are defined as qnorm((1-confidence_level)/2) * standard error. Uniform bands are constructed by multiplying the standard error with confidence_level-quantile of the bootstrapped Kolmogorov-Smirnov statistic as in Chen et al. (2017).

Value

The function summary.dfl_decompose() displays the decompositions terms save in object. The function further returns a list with the displayed decomposition terms and, if standard errors were bootstrapped, the corresponding standard errors and confindence bands.

References

Chen, Mingli, Victor Chernozhukov, Iván Fernández-Val, and Blaise Melly. 2017. "Counterfactual: An R Package for Counterfactual Analysis." The R Journal 9(1): 370-384.

ddecompose documentation built on May 29, 2024, 5:36 a.m.