RegressionKink.effect_summary

RegressionKink.effect_summary(*, direction='increase', alpha=0.05, min_effect=None, **kwargs)

Generate a decision-ready summary of causal effects for Regression Kink.

Parameters:

• direction ({"increase", "decrease", "two-sided"}, default="increase") – Direction for tail probability calculation (PyMC only, ignored for OLS).

• alpha (float, default=0.05) – Significance level for HDI/CI intervals (1-alpha confidence level).

• min_effect (float, optional) – Region of Practical Equivalence (ROPE) threshold (PyMC only, ignored for OLS).

• kwargs (Any)

Returns:

Object with .table (DataFrame) and .text (str) attributes

Return type:

EffectSummary