createsOutput {SpaDES.core} | R Documentation |
Define an output object of a module
Description
Used to specify an output object's name, class, description and other specifications.
Usage
createsOutput(objectName, objectClass, desc, ...)
## S4 method for signature 'ANY,ANY,ANY'
createsOutput(objectName, objectClass, desc, ...)
## S4 method for signature 'character,character,character'
createsOutput(objectName, objectClass, desc, ...)
Arguments
objectName |
Character string to define the output object's name. |
objectClass |
Character string to specify the output object's class. |
desc |
Text string providing a brief description of the output object.
If there are extra spaces or carriage returns, these will be stripped,
allowing for multi-line character strings without using |
... |
Other specifications of the output object. |
Value
A data.frame
suitable to be passed to outputObjects
in
a module's metadata.
Author(s)
Yong Luo
Examples
outputObjects <- bindrows(
createsOutput(objectName = "outputObject1", objectClass = "character",
desc = "this is for example"),
createsOutput(objectName = "outputObject2", objectClass = "numeric",
desc = "this is for example",
otherInformation = "I am the second output object")
)
[Package SpaDES.core version 2.1.0 Index]