par_option: Helper for defining the settings of a parameter

View source: R/fit.R

par_optionR Documentation

Helper for defining the settings of a parameter

Description

Helper for defining the settings of a parameter

Usage

par_option(option = "fixed", mean = 0, sd = 1)

Arguments

option

Should the parameter be estimated freely ("fixed"), coupled across groups ("coupled"), revolve around an estimated mean and sd ("random"), or a fixed mean and sd ("prior"). The "coupled" and "random" options are not applicable if only one parameter is estimated (e.g. log_K).

mean

Mean value of the parameter. Treated as a starting value if option is "random" or as a prior if option is option is "prior". Ignored if option is "fixed", or "coupled".

sd

SD value of the parameter. Treated as a starting value if option is "random" or a prior if option is "prior". Ignored if option is "fixed", or "coupled".

Details

mean and sdinputs can be a vector of equal length as the number of parameter values if priors are being defined.


PaulRegular/MSP documentation built on Dec. 16, 2024, 1:59 p.m.