generate_stochastic: Create a stochastic compartmental simulation model

In andreashandel/modelbuilder: Building Compartmental Simulation Models Without Coding

Create a stochastic compartmental simulation model

Description

The model needs to adhere to the structure specified by the modelbuilder package. Models built using the modelbuilder package automatically have the right structure. A user can also build a model list structure themselves following the modelbuilder specifications. If the user provides a file name, this file needs to be an Rds file and contain a valid modelbuilder model structure.

Usage

generate_stochastic(mbmodel, location = NULL, filename = NULL)

Arguments

mbmodel	modelbuilder model structure, either as list object or file name
location	a path to save the simulation code to. If NULL, defaults to current directory.
filename	a filename to save the simulation code to. If NULL, a default is generated (recommended).

Details

This function takes as input a modelbuilder model and writes code for a stochastic simulator function implemented with adaptivetau

Value

The function does not return anything Instead, it writes an R file into the specified directory the default name of the file is simulate_model$title_ode.R if the user specifies a file name, it will be that name

Author(s)

Andreas Handel

andreashandel/modelbuilder documentation built on April 16, 2024, 8:48 a.m.