if2_control: Control for IF2

In mrc-ide/mcstate: Monte Carlo Methods for State Space Models

Control for IF2

Description

Control for if2(). This function constructs a list of options and does some basic validation. Do not manually change the values in this object. Do not refer to any argument by position as the order of the arguments may change in future.

Usage

if2_control(pars_sd, iterations, n_par_sets, cooling_target, progress = TRUE)

Arguments

pars_sd	The initial standard deviation of parameter walks.
iterations	The number of IF2 iterations to run, across which the cooling is performed
n_par_sets	The number of parameter sets to walk (c.f. the population size)
cooling_target	A factor < 1 multiplying pars_sd, which will be reached by the end of the iterations, and approached geometrically
progress	Logical, indicating if a progress bar should be displayed, using progress::progress_bar.

Value

An if2_control object, which should not be modified once created. Pass this into if2()

Examples

mcstate::if2_control(list(beta = 0.2, gamma = 0.2), 100, 1000, 0.5)

mrc-ide/mcstate documentation built on July 3, 2024, 1:34 p.m.