times

0th

Percentile

Time usage in SpaDES

Functions for the 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)

Usage
times(x, ...)

# S4 method for .simList times(x)

times(x) <- value

# S4 method for .simList times(x) <- value

time(x, unit, ...)

# S4 method for .simList,missing time(x)

# S4 method for .simList,character time(x, unit)

time(x) <- value

# S4 method for .simList time(x) <- value

end(x, unit, ...)

# S4 method for .simList,missing end(x)

# S4 method for .simList,character end(x, unit)

end(x) <- value

# S4 method for .simList end(x) <- value

start(x, unit, ...)

# S4 method for .simList,missing start(x)

# S4 method for .simList,character start(x, unit)

start(x) <- value

# S4 method for .simList start(x) <- value

timeunit(x)

# S4 method for .simList timeunit(x)

timeunit(x) <- value

# S4 method for .simList timeunit(x) <- value

timeunits(x)

# S4 method for .simList timeunits(x)

Arguments
x

A simList simulation object.

...

Additional parameters.

value

A time, given as a numeric, optionally with a unit attribute, but this will be deduced from the model time units or module time units (if used within a module)

unit

Character. One of the time units used in SpaDES.

Details

NOTE: These have default behavior that is based on the calling frame timeunit. When used inside a module, then the time is in the units of the module. If used in an interactive mode, then the time will be in the units of the spades simulation.

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 there are parent modules, then the parent module timeunit will be used even if one of its children is a smaller timeunit. If all modules, including parents, are set to NA, timeunit defaults to seconds. If parents are set to NA, then the set of modules defined by that parent module will be given the smallest units of the children.

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.

In many cases, the "simpler" use of each of these functions may be slower computationally. For instance, it is much faster to use time(sim, "year") than time(sim). So as a module developer, it is advantageous to write out the longer one, minimizing the looking up that R must do.

Value

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

See Also

SpaDES, specifically the section 1.2.5 on Simulation times.

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

Aliases
  • end
  • end,.simList,character-method
  • end,.simList,missing-method
  • end<-
  • end<-,.simList-method
  • simList-accessors-times
  • start
  • start,.simList,character-method
  • start,.simList,missing-method
  • start<-
  • start<-,.simList-method
  • time
  • time,.simList,character-method
  • time,.simList,missing-method
  • time<-
  • time<-,.simList-method
  • times
  • times,.simList-method
  • times<-
  • times<-,.simList-method
  • timeunit
  • timeunit,.simList-method
  • timeunit<-
  • timeunit<-,.simList-method
  • timeunits
  • timeunits,.simList-method
Documentation reproduced from package SpaDES, version 1.3.1, License: GPL-3

Community examples

Looks like there are no examples yet.