ExtractParameters {scSpatialSIM} | R Documentation |
Get Simulation Parameters
Description
Get Simulation Parameters
Usage
ExtractParameters(sim_object, steps = NULL)
Arguments
sim_object |
simulation object created with |
steps |
which parameters to extract from the |
Details
This function will return any paramters that are stored in the simulation object. If no simulation steps have been run, then this will return the default parameters. The defaults are over written if new parameters are provided at each step.
Value
a list of S3 clas SimParams
containing parameters stored in the sim_object
Examples
#create simulation object
sim_obj = CreateSimulationObject()
#extract default paramters for the Tissue simulation step
defs = ExtractParameters(sim_obj, "Tissue")
[Package scSpatialSIM version 0.1.3.3 Index]