objs

0th

Percentile

Extract or replace an object from the simulation environment

The [[ and $ operators provide "shortcuts" for accessing objects in the simulation environment. I.e., instead of using envir(sim)$object or envir(sim)[["object"]], one can simply use sim$object or sim[["object"]].

Usage
objs(x, ...)
"objs"(x, ...)
objs(x) <- value
"objs"(x) <- value
"[["(x, i, j, ..., drop)
"[["(x, i) <- value
"$"(x, name)
"$"(x, name) <- value
Arguments
x
A simList object from which to extract element(s) or in which to replace element(s).
...
see i.
value
Any R object.
i
Indices specifying elements to extract or replace.
j
see i.
drop
not implemented.
name
A literal character string or a name.
Details

objs can take ... arguments passed to ls, allowing, e.g. all.names=TRUE objs<- requires takes a named list of values to be assigned in the simulation envirment.

Value

Returns or sets a list of objects in the simList environment.

See Also

ls-method, ls_str-method, simList-class, simList-accessors-envir, simList-accessors-events, simList-accessors-inout, simList-accessors-modules, simList-accessors-params, simList-accessors-paths, simList-accessors-times.

Aliases
  • $
  • $,simList-method
  • $<-
  • $<-,simList-method
  • [[
  • [[,simList,ANY,ANY-method
  • [[<-
  • [[<-,simList,ANY,ANY,ANY-method
  • objs
  • objs,simList-method
  • objs<-
  • objs<-,simList-method
  • simList-accessors-objects
Documentation reproduced from package SpaDES, version 1.2.0, License: GPL-3

Community examples

Looks like there are no examples yet.