Description Usage Format Contracted Methods Private See Also
Defines a contract of implementation for any module based class, i.e. a class that extends this interface. This class cannot be instantiated directly as it is abstract.
1 |
An object of class R6ClassGenerator
of length 24.
clearOutputCache()
Clears out the cached output of the associated module.
getFuncObj()
Gets the base R function object that is called when the associated module's execution is started.
getInput()
Gets a named logical vector where the names are the possible inputs into a module and the values indicate if an input is required.
getOutput()
Gets the output of the associated module.
hasCompleted()
Indicates if the associated module's execution has completed.
startExecution(argsList)
Starts the execution of the
associated module with argsList
as arguments.
getName()
Gets the name of this function.
Returns: character string that is the name of this module.
setName(arg)
Set the name of the module. Considers arg of length 1 of character type.
setModuleStartTime()
Set the current system time as the time when the execution of the associated module was initiated.
getModuleStartTime()
Get the time when the execution of the associated module was initiated.
setModuleEndTime()
Set the current system time as the time when the execution of the associated module was completed
getModuleEndTime()
Get the time when the execution of the associated module was completed.
setExecutionStatus(arg)
Set the status of execution - whether
it was successfully completed or not. arg
indicates a logical
vector of length 1.
getExecutionStatus()
Get the status of execution - whether it was successfully completed or not.
getExecutionTimings()
The list of timings indicating the module name, start-time and end-time.
ReturnsA list
with: name
,
startTime
& endTime
of the associated module
was initiated.
moduleStartTime
The time when the execution of the associated module was initiated.
moduleEndTime
The time when the execution of the associated module was completed
successfulExecution
A logical vector of length 1 that indicates whether the module was successfully executed. It could take the following values:
NULL
Module Execution incomplete.
FALSE
Execution Failed.
TRUE
Successful execution.
is.Module
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.