prior_dist: User-facing constructor for new 'prior_dist' objects

Description Usage Arguments Value

View source: R/stan_utils.R

Description

User-facing constructor for new prior_dist objects

Usage

1
prior_dist(name, params, bounds = NA)

Arguments

name

a string with the name of the distribution (e.g. 'normal'). Must match a distribution in ALLOWED_DISTRIBUTIONS list

params

parameters for the prior distribution. Should match the number and constrains imposed by the distribution name.

bounds

a lower and upper bound for the parameter. This restricts the range in which sampling occurs. If left as NA, no bounds are imposed

Value

a new prior_dist object in the arguments specify a valid distribution. Throws an error otherwise.


jproney/bpinference documentation built on April 19, 2021, 2:18 a.m.