SpaDES (version 1.3.1)

createsOutput: 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 ANY,ANY,ANY
createsOutput(objectName, objectClass, desc, ...)
# S4 method for 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.

...

Other specifications of the output object.

Value

A data.frame suitable to be passed to outputObjects in a module's metadata.

Examples

# NOT RUN {
outputObjects <- dplyr::bind_rows(
  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")
)

# }