bayesplain.priors.resolve_effect_size

bayesplain.priors.resolve_effect_size(prior)[source]

Turn whatever the user passed as prior= into an EffectSizePrior.

Accepts a preset name, a positive number read as the Cauchy scale, an existing EffectSizePrior, or None for the conventional default.

Parameters:
prior : str, float, EffectSizePrior, or None

The prior specification. None resolves to "conventional".

Returns:

The resolved prior.

Return type:

EffectSizePrior

Raises:

ValueError – If a name is not a known preset, or the value is not a positive number.