SpaDES
simtimes
slot of a simList
object
and its elements. To maintain modularity, the behavior of these functions depends
on where they are used. In other words, different modules can have their own
timeunit. SpaDES
converts these to seconds when running a simulation, but
shows the user time in the units of the model as shown with timeunit(sim)
times(x, ...)## S3 method for class '.simList':
times(x)
times(x) <- value
## S3 method for class '.simList':
times(x) <- value
time(x, unit, ...)
## S3 method for class '.simList,missing':
time(x)
## S3 method for class '.simList,character':
time(x, unit)
time(x) <- value
## S3 method for class '.simList':
time(x) <- value
end(x, unit, ...)
## S3 method for class '.simList,missing':
end(x)
## S3 method for class '.simList,character':
end(x, unit)
end(x) <- value
## S3 method for class '.simList':
end(x) <- value
start(x, unit, ...)
## S3 method for class '.simList,missing':
start(x)
## S3 method for class '.simList,character':
start(x, unit)
start(x) <- value
## S3 method for class '.simList':
start(x) <- value
.callingFrameTimeunit(x)
## S3 method for class '.simList':
.callingFrameTimeunit(x)
## S3 method for class '`NULL`':
.callingFrameTimeunit(x)
timeunit(x)
## S3 method for class '.simList':
timeunit(x)
timeunit(x) <- value
## S3 method for class '.simList':
timeunit(x) <- value
timeunits(x)
## S3 method for class '.simList':
timeunits(x)
simList
simulation object.SpaDES
.simList
object.Additonal methods are provided to access the current, start, and end times
of the simulation:
time
Current simulation time.
start
Simulation start time.
end
Simulation end time.
timeunit
Simulation timeunit.
timeunits
Module timeunits.
times
List of all simulation times (current, start, end, timeunit).
}
timeunit
will extract the current units of the time used in a
simulation (i.e., within a spades
call).
If it is set within a simInit
, e.g.,
times=list(start=0, end=52, timeunit = "week")
, it will set the
units for that simulation.
By default, a simInit
call will use the smallest unit contained within
the metadata for the modules being used.
If NA
, timeunit
defaults to none.
Currently, available units are "second", "hours", day", "week", "month", and "year" can be used in the metadata of a module.
The user can also define a new unit. The unit name can be anything, but the
function definition must be of the form, dunitName, e.g., dyear or dfortnight.
The unit name is the part without the 'd' and the function name definition
includes the 'd'. This new function, e.g.,
dfortNight <- function(x) lubridate::duration(dday(14))
can be placed anywhere in the search path or in a module.
timeunits
will extract the current units of the time of all
modules used in a simulation.
This is different from timeunit
because it is not necessarily
associated with a spades
call.
simList-class
,
simList-accessors-envir
,
simList-accessors-events
,
simList-accessors-inout
,
simList-accessors-modules
,
simList-accessors-objects
,
simList-accessors-params
,
simList-accessors-paths
.