diff_diff.TripleDifferenceResults

class diff_diff.TripleDifferenceResults[source]

Bases: object

Results from Triple Difference (DDD) estimation.

Provides access to the estimated average treatment effect on the treated (ATT), standard errors, confidence intervals, and diagnostic information.

att

Average Treatment effect on the Treated (ATT). This is the effect on units in the treated group (G=1) and eligible partition (P=1) after treatment (T=1).

Type:: float

se

Standard error of the ATT estimate.

Type:: float

t_stat

T-statistic for the ATT estimate.

Type:: float

p_value

P-value for the null hypothesis that ATT = 0.

Type:: float

conf_int

Confidence interval for the ATT.

Type:: tuple[float, float]

n_obs

Total number of observations used in estimation.

Type:: int

n_treated_eligible

Number of observations in treated group and eligible partition.

Type:: int

n_treated_ineligible

Number of observations in treated group and ineligible partition.

Type:: int

n_control_eligible

Number of observations in control group and eligible partition.

Type:: int

n_control_ineligible

Number of observations in control group and ineligible partition.

Type:: int

estimation_method

Estimation method used: “dr” (doubly robust), “reg” (regression adjustment), or “ipw” (inverse probability weighting).

Type:: str

alpha

Significance level used for confidence intervals.

Type:: float

__init__(att, se, t_stat, p_value, conf_int, n_obs, n_treated_eligible, n_treated_ineligible, n_control_eligible, n_control_ineligible, estimation_method, alpha=0.05, group_means=None, pscore_stats=None, r_squared=None, covariate_balance=None, inference_method='analytical', n_bootstrap=None, n_clusters=None)

Parameters:

att (float)
se (float)
t_stat (float)
p_value (float)
conf_int (Tuple[float, float])
n_obs (int)
n_treated_eligible (int)
n_treated_ineligible (int)
n_control_eligible (int)
n_control_ineligible (int)
estimation_method (str)
alpha (float)
group_means (Dict[str, float] | None)
pscore_stats (Dict[str, float] | None)
r_squared (float | None)
covariate_balance (DataFrame | None)
inference_method (str)
n_bootstrap (int | None)
n_clusters (int | None)

Return type:

None

Methods

`__init__`(att, se, t_stat, p_value, conf_int, ...)
`print_summary`([alpha])	Print the summary to stdout.
`summary`([alpha])	Generate a formatted summary of the estimation results.
`to_dataframe`()	Convert results to a pandas DataFrame.
`to_dict`()	Convert results to a dictionary.

Attributes

`alpha`
`covariate_balance`
`group_means`
`inference_method`
`is_significant`	Check if the ATT is statistically significant at the alpha level.
`n_bootstrap`
`n_clusters`
`pscore_stats`
`r_squared`
`significance_stars`	Return significance stars based on p-value.
`att`
`se`
`t_stat`
`p_value`
`conf_int`
`n_obs`
`n_treated_eligible`
`n_treated_ineligible`
`n_control_eligible`
`n_control_ineligible`
`estimation_method`

att: float

se: float

t_stat: float

p_value: float

conf_int: Tuple[float, float]

n_obs: int

n_treated_eligible: int

n_treated_ineligible: int

n_control_eligible: int

n_control_ineligible: int

estimation_method: str

alpha: float = 0.05

group_means: Dict[str, float] | None = None

pscore_stats: Dict[str, float] | None = None

r_squared: float | None = None

covariate_balance: DataFrame | None = None

inference_method: str = 'analytical'

n_bootstrap: int | None = None

n_clusters: int | None = None

__repr__()[source]

Concise string representation.

Return type:: str

summary(alpha=None)[source]

Generate a formatted summary of the estimation results.

Parameters:: alpha (float, optional) – Significance level for confidence intervals. Defaults to the alpha used during estimation.
Returns:: Formatted summary table.
Return type:: str

print_summary(alpha=None)[source]

Print the summary to stdout.

Parameters:: alpha (float | None)
Return type:: None

to_dict()[source]

Convert results to a dictionary.

Returns:: Dictionary containing all estimation results.
Return type:: Dict[str, Any]

to_dataframe()[source]

Convert results to a pandas DataFrame.

Returns:: DataFrame with estimation results.
Return type:: pd.DataFrame

property is_significant: bool: Check if the ATT is statistically significant at the alpha level.

property significance_stars: str: Return significance stars based on p-value.

__init__(att, se, t_stat, p_value, conf_int, n_obs, n_treated_eligible, n_treated_ineligible, n_control_eligible, n_control_ineligible, estimation_method, alpha=0.05, group_means=None, pscore_stats=None, r_squared=None, covariate_balance=None, inference_method='analytical', n_bootstrap=None, n_clusters=None)

Parameters:

att (float)
se (float)
t_stat (float)
p_value (float)
conf_int (Tuple[float, float])
n_obs (int)
n_treated_eligible (int)
n_treated_ineligible (int)
n_control_eligible (int)
n_control_ineligible (int)
estimation_method (str)
alpha (float)
group_means (Dict[str, float] | None)
pscore_stats (Dict[str, float] | None)
r_squared (float | None)
covariate_balance (DataFrame | None)
inference_method (str)
n_bootstrap (int | None)
n_clusters (int | None)

Return type:

None