OutputParam: Output parameters

In Rcwl: An R interface to the Common Workflow Language

Description

An output parameter for a Command Line Tool. More details: https://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputParameter

Usage

OutputParam(
  id = "output",
  label = character(),
  doc = character(),
  type = "stdout",
  format = character(),
  secondaryFiles = character(),
  streamable = logical(),
  glob = character(),
  loadContents = logical(),
  outputEval = character(),
  outputSource = character()
)

Arguments

id	The unique identifier for this parameter object.
label	A short, human-readable label of this object.
doc	A documentation string for this object, or an array of strings which should be concatenated.
type	Specify valid types of data that may be assigned to this parameter.
format	Only valid when type: File or is an array of items: File. This is the file format that will be assigned to the output File object.
secondaryFiles	Provides a pattern or expression specifying files or directories. Only valid when type: File or is an array of items: File.
streamable	A value of true indicates that the file is read or written sequentially without seeking. Only valid when type: File or is an array of items: File.
glob	Pattern to find files relative to the output directory.
loadContents	Read text from globbed file.
outputEval	Evaluate an expression to generate the output value.
outputSource	Specifies one or more workflow parameters that supply the value of to the output parameter.

Value

An object of class 'OutputParam'.

Examples

o1 <- OutputParam(id = "file", type = "File", glob = "*.txt")

Rcwl documentation built on Nov. 8, 2020, 8:11 p.m.