ExperimentResult.effect_summary#

ExperimentResult.effect_summary(**kwargs)[source]#

Get a structured effect summary.

Parameters:

**kwargs: Keyword arguments passed to result.effect_summary(). Common arguments include direction ("increase", "decrease", "two-sided"), alpha (HDI level), and min_effect (ROPE threshold).

Returns:

object: Effect summary with .table (DataFrame) and .text (string) attributes.