summary.ICI: Summarize a ICI Object

Description Usage Arguments Details Examples

Description

Print the main caracteristics of an ICI object.

Usage

1
2
## 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

1
2
3
4
data(hhbudgets)

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


Search within the IC2 package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.