Skip to content

Specifies a Cauchy(0, scale) prior on model parameters. This is the default prior for pairwise interactions in bgm and produces heavy-tailed shrinkage toward zero.

Usage

cauchy_prior(scale = 1)

Arguments

scale

Positive numeric. Scale (half-width at half-maximum) of the Cauchy distribution. Default: 1.

Value

An object of class "bgms_parameter_prior" with family = "cauchy".

Examples

cauchy_prior()
#> Parameter prior: Cauchy(0, 1)
cauchy_prior(scale = 2.5)
#> Parameter prior: Cauchy(0, 2.5)