Parameter: Paramter class (reference class)

In sbg/sevenbridges-r: Seven Bridges Platform API Client and Common Workflow Language Tool Builder in R

Description

Define an input or output parameter to a process.

Usage

InputParameterList(...)

OutputParameterList(...)

Arguments

...	element or list of the element.

Value

Parameter object

Fields

type

[ANY] Specify valid types of data that may be assigned to this parameter.

label

[character] A short, human-readable label of this parameter object.

description

[character] A long, human-readable description of this parameter object.

streamable

[logical] Currently only applies if type is File. A value of true indicates that the file is read or written sequentially without seeking. An implementation may use this flag to indicate whether it is valid to stream file contents using a named pipe. Default: false.

default

[ANY] The default value for this parameter if not provided in the input object.

id

(character) The unique identifier for this parameter object.

inputBinding

[Binding] Describes how to handle the inputs of a process and convert them into a concrete form for execution, such as command line parameters.

id

(character) The unique identifier for this parameter object.

Examples

Parameter(
  type = "integer", label = "thread",
  description = "Specify the thread #",
  default = 0
)

ipl <- InputParameterList(
  InputParameter(
    id = "BAM", type = "File",
    label = "input bam",
    description = "input bam",
    inputBinding = CommandLineBinding(
      position = 1L
    )
  ),
  InputParameter(
    id = "level", type = "Integer",
    label = "Compression level",
    description = "Compression level",
    inputBinding = CommandLineBinding(
      position = 2L,
      prefix = "-l"
    )
  )
)
ipl

sbg/sevenbridges-r documentation built on March 26, 2021, 3:33 p.m.