Summarize a ICI Object

Description

Print the main caracteristics of an ICI object.

Usage

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

Arguments

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))

Results

R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(IC2)
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/IC2/summary.ICI.Rd_%03d_medium.png", width=480, height=480)
> ### Name: summary.ICI
> ### Title: Summarize a ICI Object
> ### Aliases: summary.ICI
> 
> ### ** Examples
> 
> data(hhbudgets)
> 
> summary(calcAtkinson(hhbudgets[,"ingreso"], epsilon=3), digits=3)
    Atk        epsilon        
  0.605          3.000        
> summary(decompGEI(hhbudgets[,"ingreso"], hhbudgets[,"estructura"], alpha=1.1))
    GEI          alpha        
0.49739        1.10000        

Decomposition:
   within    between  
0.4897908  0.0075969  
betweenELMO  
    0.30314  
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>