namespacing: Namespacing within 'SpaDES'

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Namespacing within SpaDES

Description

This will only return the module name if it is inside a spades call, i.e., it will return NULL if used in interactive mode. The related function currentModule is simply a rapid accessor for the current module name. This latter will return the module that is in the current event queue, which will never be NULL.

Usage

.callingModuleName(sim)

## S4 method for signature 'simList'
.callingModuleName(sim)

currentModule(sim)

## S4 method for signature 'simList'
currentModule(sim)

.callingFrameTimeunit(x)

Arguments

sim	A simList object from which to extract element(s) or in which to replace element(s).
x	A simList

Value

.callingModuleName returns the name of the module that is currently the active module calling functions like scheduleEvent.

Author(s)

Eliot McIntire

SpaDES.core documentation built on Nov. 10, 2023, 5:08 p.m.