summary.ICI: Summarize a ICI Object

In IC2: Inequality and Concentration Indices and Curves

Description

Print the main caracteristics of an ICI object.

Usage

## S3 method for class 'ICI'
summary(object, ...)

Arguments

object	An ICI object.
...	Number of significant digits to be used in the result.

Details

Values of the index and the parameter are systematically printed. If x is the result of a subgroup decomposition, the function also prints the type of decomposition (when necessary), the values of the between-group, within-group and residual (when necessary) inequality indices and, if calculated, the maximum between-group inequality index.

Examples

data(hhbudgets)

summary(calcAtkinson(hhbudgets[,"ingreso"], epsilon=3), digits=3)
summary(decompGEI(hhbudgets[,"ingreso"], hhbudgets[,"estructura"], alpha=1.1))

Example output

    Atk        epsilon        
  0.605          3.000        
    GEI          alpha        
0.49739        1.10000        

Decomposition:
   within    between  
0.4897908  0.0075969  
betweenELMO  
    0.30314  

IC2 documentation built on May 1, 2019, 7:49 p.m.