SpaDES (version 1.3.1)

params: Get and set simulation parameters.

Description

params and P access the parameter slot in the simList. params has a replace method, so can be used to update a parameter value.

P is a concise way to access parameters within a module. It works more like a namespaced function in the sense that the module from which it is called is the default place it will look for the parameter. To access a parameter from within a module, you can use P(sim)$paramName instead of params(sim)$moduleName$paramName

Usage

params(object)
# S4 method for .simList
params(object)
params(object) <- value
# S4 method for .simList
params(object) <- value
P(object, module = NULL, param = NULL)
# S4 method for .simList
P(object, module = NULL, param = NULL)
parameters(object, asDF = FALSE)
# S4 method for .simList
parameters(object, asDF = FALSE)
p(object, module = NULL, param = NULL)

Arguments

object

A simList simulation object.

value

The object to be stored at the slot.

module

Optional character string indicating which module params should come from.

param

Optional character string indicating which parameter to choose.

asDF

Logical. For parameters, if TRUE, this will produce a single data.frame of all model parameters. If FALSE, then it will return a data.frame with 1 row for each parameter within nested lists, with the same structure as params.

Value

Returns or sets the value of the slot from the simList object.

See Also

SpaDES, specifically the section 1.2.1 on Simulation parameters.

Other functions to access elements of a simList object: .addDepends, doEvent.checkpoint, envir, events, globals, inputs, ls.simList, ls.str.simList, modules, objs, packages, paths, progressInterval, times

Examples

# NOT RUN {
modules = list("randomLandscapes")
paths = list(modulePath = system.file("sampleModules", package = "SpaDES"))
mySim <- simInit(modules = modules, paths = paths,
                 params = list(.globals = list(stackName = "landscape")))
parameters(mySim)

# }