statsmodels.stats.oaxaca.OaxacaResults

class statsmodels.stats.oaxaca.OaxacaResults(results, model_type, std_val=None)

This class summarizes the fit of the OaxacaBlinder model

Parameters:

resultstuple of float

The estimated effects. For a two-fold decomposition this is (unexplained, explained, gap); for a three-fold decomposition this is (endowment effect, coefficient effect, interaction effect, gap).

model_typeint

The type of decomposition that produced results. 2 indicates a two-fold decomposition and 3 indicates a three-fold decomposition.

std_valtuple of float or None, optional

The bootstrapped standard errors corresponding to each value in results, in the same order. None if standard errors were not requested.

Attributes:

params

A list of all values for the fitted models.

std

A list of standard error calculations.

Methods

summary()

Print a summary table with the Oaxaca-Blinder effects

Notes

Use .summary() to get a table of the fitted values or use .params to receive a list of the values use .std to receive a list of the standard errors

If a two-fold model was fitted, this will return unexplained effect, explained effect, and the mean gap. The list will always be of the following order and type. If standard error was asked for, then standard error calculations will also be included for each variable after each calculated effect.

unexplainedfloat

This is the effect that cannot be explained by the data at hand. This does not mean it cannot be explained with more.

explainedfloat

This is the effect that can be explained using the data.

gapfloat

This is the gap in the mean differences of the two groups.

If a three-fold model was fitted, this will return characteristic effect, coefficient effect interaction effect, and the mean gap. The list will be of the following order and type. If standard error was asked for, then standard error calculations will also be included for each variable after each calculated effect.

endowment effectfloat

This is the effect due to the group differences in predictors

coefficient effectfloat

This is the effect due to differences of the coefficients of the two groups

interaction effectfloat

This is the effect due to differences in both effects existing at the same time between the two groups.

gapfloat

This is the gap in the mean differences of the two groups.

Methods

summary()

Print a summary table with the Oaxaca-Blinder effects