R: Prints and returns a summary for a 'decomposition' object.

summary.decomposition {rineq}

R Documentation

Prints and returns a summary for a `decomposition` object.

Description

Prints and returns a summary for a decomposition object.

Usage

## S3 method for class 'decomposition'
summary(object, digits = getOption("digits"), addcoefs = FALSE, ...)

Arguments

`object`	Result of a decomposition analysis, of class `decomposition`
`digits`	Number of digits, defaults to R `digits` option
`addcoefs`	Whether or not to add coefficients (defaults to `FALSE`)
`...`	Additional parameters, currently unused

Value

A data frame frame with columns for the absolute and relative contribution, elasticity, concentration index including confidence intervals, and whether correction was applied. If specified using addcoefs, the coefficients are included as the first column.

Examples

data(housing)
# Linear regression & decompose 
fit.lm <- lm(bmi ~ sex + tenure + place + age,data = housing)
contrib.lm <- contribution(fit.lm, housing$income)

# print
print(contrib.lm)