Define an input object that the module expects.

Used to specify an input object's name, class, description, source url and other specifications.

expectsInput(objectName, objectClass, desc, sourceURL, ...)

# S4 method for class 'ANY,ANY,ANY,ANY'
expectsInput(objectName, objectClass, desc, sourceURL, ...)

# S4 method for class 'character,character,character,character'
expectsInput(objectName, objectClass, desc, sourceURL, ...)

# S4 method for class 'character,character,character,missing'
expectsInput(objectName, objectClass, desc, sourceURL, ...)

Arguments

objectName: Character string to define the input object's name.
objectClass: Character string to specify the input object's class.
desc: Text string providing a brief description of the input 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.
sourceURL: Character string to specify an URL to reach the input object, default is NA.
...: Other specifications of the input object.

Value

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

Author

Yong Luo

Examples

inputObjects <- bindrows(
  expectsInput(objectName = "inputObject1", objectClass = "character",
               desc = "this is for example", sourceURL = "not available"),
  expectsInput(objectName = "inputObject2", objectClass = "numeric",
               desc = "this is for example", sourceURL = "not available",
               otherInformation = "I am the second input object")
)