ApplicationParameterFlagValue: ApplicationParameterFlagValue Class

Description Usage Format Fields

Description

An ApplicationParameter representing a flag value

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Fields

defaultValue

The default value for this parameter. The type will be determined by the value.type field.

enumValues

An array of enumerated object values.

enquote

Whether the argument value should be surrounded by quotation marks before injection into the wrapper template at runtime

order

The order in which this parameter should be printed when generating an execution command for forked execution. This will also be the order in which paramters are returned in the response json.

required

Is this parameter required? If visible is false, this must be true.

type

The type of this parameter value. (Acceptable values are: "string", "number", "enumeration", "bool", "flag")

validator

The regular expression used to validate this parameter value. For enumerations, separate values with |

visible

Should this parameter be visible? If not, there must be a default and it will be required.


agaveplatform/r-sdk documentation built on May 13, 2019, 8:20 a.m.