Skip to contents

Control whether outbreak simulation continues stepping

Source: R/aux_functions.R
outbreak_continue.Rd

Used in a while loop to determine whether the outbreak_model() continues to call outbreak_step(), or to end the simulation.

Usage

outbreak_continue(case_data, sim)

Arguments

case_data

a data.table: cases in outbreak so far; initially generated by outbreak_setup()

sim

a list with class <ringbp_sim_opts>: the simulation control options for the ringbp model, returned by sim_opts()

Value

a logical scalar: whether the outbreak is still active and should continue (TRUE) or if the outbreak is extinct or has reached a stopping criterion (FALSE).