Used to specify an output object's name, class, description and other specifications.
createsOutput(objectName, objectClass, desc, ...)
# S4 method for ANY,ANY,ANY
createsOutput(objectName, objectClass, desc, ...)
# S4 method for character,character,character
createsOutput(objectName, objectClass, desc, ...)
Character string to define the output object's name.
Character string to specify the output object's class.
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 paste
or multiple quotes.
Other specifications of the output object.
A data.frame
suitable to be passed to outputObjects
in
a module's metadata.
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")
)