Description Usage Arguments Details Value Examples
Defines a prior distribution/probability density function for the average effect size d or for the heterogeneity of effect sizes τ.
1 2 3 4 5 6 7 8 
family 
a character value defining the distribution family. 
param 
numeric parameters for the distribution. See details for the definition of the parameters of each family. 
lower 
lower boundary for truncatation of prior density.
If 
upper 
See 
label 
optional: parameter label. 
rel.tol 
relative tolerance used for integrating the density of 
The following prior distributions are currently implemented:
"norm"
: Normal distribution with param = c(mean, sd)
(see Normal
).
"t"
: Student's tdistribution with param = c(location, scale, nu)
where nu
are the degrees of freedom (see dist.Student.t
).
"cauchy"
: Cauchy distribution with param = c(location, scale)
.
The Cauchy distribution is a special case of the tdistribution with degrees of freedom nu=1
.
"gamma"
: Gamma distribution with param = c(shape, rate)
with rate parameter equal to the inverse scale (see GammaDist
).
"invgamma"
: Inverse gamma distribution with param = c(shape, scale)
(see dist.Inverse.Gamma
).
"beta"
: (Scaled) beta distribution with param = c(shape1, shape2)
(see Beta
).
"custom"
: Userspecified prior density function defined by param
(see examples; the density must be nonnegative and vectorized, but is normalized
internally). Integration is performed from (Inf, Inf), which requires that the
function returns zeros (and not NAs) for values not in the support of the distribution.
an object of the class prior
: a density function with the arguments
x
(parameter values) and log
(whether to return density or logdensity).
1 2 3 4 5 6 7 8 9 10 11 12 13  ### HalfNormal Distribution
p1 < prior("norm", c(mean = 0, sd = .3), lower = 0)
p1
p1(c(1, 1, 3))
plot(p1, .1, 1)
### HalfCauchy Distribution
p2 < prior("cauchy", c(location = 0, scale = .3), lower = 0)
plot(p2, .5, 3)
### Custom Prior Distribution
p3 < prior("custom", function(x) x^2, 0, 1)
plot(p3, .1, 1.2)

Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.