Simulator: A R6 class that is the super class for all numerical...
In junlingm/REpiSim: Mathematical Epidemiological Model Simulations in R
Simulator R Documentation
A R6 class that is the super class for all numerical simulators
Description
A R6 class that is the super class for all numerical simulators
A R6 class that is the super class for all numerical simulators
Details
The main method is 'simulate'.
the Simulation class is an abstract class. It's constructor
should not be explicitly called.
Active bindings
modela read-only field returning the simulation code
for the model.
Methods
Public methods
Method new()
constructor
Usage
Simulator$new(model)
Arguments
modelthe model to simulate
Method simulate()
simulate the model
Usage
Simulator$simulate(t, y0, parms = NULL, vars = names(y0), ...)
Arguments
ta numeric vector of times.
y0a numeric vector of initial conditions.
parmsa numeric vector of parameter values.
varsa character vector specifying the variable names to be returned.
A variable can be either a compartment or a substitution
...extra arguments to be passed to the 'ode' method
substitutions that depend on the compartments are calculated
and returned
Returns
a data frame which rows correspond to each time in 't',
and columns correspond to the variables specified in vars.
Method clone()
The objects of this class are cloneable with this method.
Usage
Simulator$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
junlingm/REpiSim documentation built on June 15, 2025, 7:36 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Simulator | R Documentation |
A R6 class that is the super class for all numerical simulators
Description
A R6 class that is the super class for all numerical simulators
A R6 class that is the super class for all numerical simulators
Details
The main method is 'simulate'.
the Simulation class is an abstract class. It's constructor should not be explicitly called.
Active bindings
modela read-only field returning the simulation code for the model.
Methods
Public methods
Method new()
constructor
Usage
Simulator$new(model)
Arguments
modelthe model to simulate
Method simulate()
simulate the model
Usage
Simulator$simulate(t, y0, parms = NULL, vars = names(y0), ...)
Arguments
ta numeric vector of times.
y0a numeric vector of initial conditions.
parmsa numeric vector of parameter values.
varsa character vector specifying the variable names to be returned. A variable can be either a compartment or a substitution
...extra arguments to be passed to the 'ode' method substitutions that depend on the compartments are calculated and returned
Returns
a data frame which rows correspond to each time in 't', and columns correspond to the variables specified in vars.
Method clone()
The objects of this class are cloneable with this method.
Usage
Simulator$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.