bayesplain.priors.resolve_correlation

bayesplain.priors.resolve_correlation(prior)[source]

Turn whatever the user passed as prior= into a CorrelationPrior.

Accepts a preset name, a positive number read as kappa, an existing CorrelationPrior, or None for the flat default.

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

The prior specification. None resolves to "uninformed".

Returns:

The resolved prior.

Return type:

CorrelationPrior

Raises:

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