summary.subpop {SortedEffects}

Return the output of subpop function.

Description

The subpop function stores the most and least affected groups. This command allows users to see these two groups and their corresponding characteristics. The command also allows users to check the summary statistics of variables in interest, which can be useful for plotting the projections plot via the plot.subpop method.

Usage

## S3 method for class 'subpop'
summary(object, vars = NULL, ...)

Arguments

object

Output of subpop command.

vars

The variables that users want to see the summary statistics. The default is NULL and the command shows all variables. The summary statistcs include min 1st quartile, median, mean, 3rd quartile and the max.

...

additional arguments affecting the summary produced.

Examples

data("mortgage")
### Regression Specification
fm <- deny ~ black + p_irat + hse_inc + ccred + mcred + pubrec +
   ltv_med + ltv_high + denpmi + selfemp + single + hischl
### Issue the subpop command
set_b <- subpop(fm, data = mortgage, method = "logit", var = "black",
u = 0.1, alpha = 0.1, b = 50)
### Produce summary of two variables
groups <- summary(set_b, vars = c("p_irat", "hse_inc"))