cwl.v1_0

CWL v1.0 parser generated with schema-salad-tool

This module was generated using schema-salad code generator.

The embedded document is subject to the license of the original schema.

Members

Aliases

DocumentRootType
alias DocumentRootType = Union!(CommandLineTool, ExpressionTool, Workflow)
importFromURI
alias importFromURI = import_!DocumentRootType

Classes

ArraySchema
class ArraySchema
CWLArraySchema
class CWLArraySchema
CWLInputFile
class CWLInputFile

Type representing a valid CWL input file as a map<string, CWLObjectType>.

CWLObjectType
class CWLObjectType

Generic type representing a valid CWL object. It is used to represent default values passed to CWL InputParameter and WorkflowStepInput record fields.

CWLRecordField
class CWLRecordField
CWLRecordSchema
class CWLRecordSchema
CWLType
class CWLType

Extends primitive types with the concept of a file and directory as a builtin type. File: A File object Directory: A Directory object

CWLVersion
class CWLVersion

Version symbols for published CWL document versions.

CommandInputArraySchema
class CommandInputArraySchema
CommandInputEnumSchema
class CommandInputEnumSchema
CommandInputParameter
class CommandInputParameter

An input parameter for a CommandLineTool.

CommandInputRecordField
class CommandInputRecordField
CommandInputRecordSchema
class CommandInputRecordSchema
CommandLineBinding
class CommandLineBinding

When listed under inputBinding in the input schema, the term "value" refers to the the corresponding value in the input object. For binding objects listed in CommandLineTool.arguments, the term "value" refers to the effective value after evaluating valueFrom.

CommandLineTool
class CommandLineTool

This defines the schema of the CWL Command Line Tool Description document.

CommandOutputArraySchema
class CommandOutputArraySchema
CommandOutputBinding
class CommandOutputBinding

Describes how to generate an output parameter based on the files produced by a CommandLineTool.

CommandOutputEnumSchema
class CommandOutputEnumSchema
CommandOutputParameter
class CommandOutputParameter

An output parameter for a CommandLineTool.

CommandOutputRecordField
class CommandOutputRecordField
CommandOutputRecordSchema
class CommandOutputRecordSchema
Directory
class Directory

Represents a directory to present to a command line tool.

Dirent
class Dirent

Define a file or subdirectory that must be placed in the designated output directory prior to executing the command line tool. May be the result of executing an expression, such as building a configuration file from a template.

DockerRequirement
class DockerRequirement

Indicates that a workflow component should be run in a Docker container, and specifies how to fetch or build the image.

EnumSchema
class EnumSchema

Define an enumerated type.

EnvVarRequirement
class EnvVarRequirement

Define a list of environment variables which will be set in the execution environment of the tool. See EnvironmentDef for details.

EnvironmentDef
class EnvironmentDef

Define an environment variable that will be set in the runtime environment by the workflow platform when executing the command line tool. May be the result of executing an expression, such as getting a parameter from input.

ExpressionTool
class ExpressionTool

Execute an expression as a Workflow step.

ExpressionToolOutputParameter
class ExpressionToolOutputParameter
File
class File

Represents a file (or group of files when secondaryFiles is provided) that will be accessible by tools using standard POSIX file system call API such as open(2) and read(2).

InitialWorkDirRequirement
class InitialWorkDirRequirement

Define a list of files and subdirectories that must be created by the workflow platform in the designated output directory prior to executing the command line tool.

InlineJavascriptRequirement
class InlineJavascriptRequirement

Indicates that the workflow platform must support inline Javascript expressions. If this requirement is not present, the workflow platform must not perform expression interpolatation.

InputArraySchema
class InputArraySchema
InputEnumSchema
class InputEnumSchema
InputParameter
class InputParameter
InputRecordField
class InputRecordField
InputRecordSchema
class InputRecordSchema
LinkMergeMethod
class LinkMergeMethod

The input link merge method, described in WorkflowStepInput.

MapSchema
class MapSchema
MultipleInputFeatureRequirement
class MultipleInputFeatureRequirement

Indicates that the workflow platform must support multiple inbound data links listed in the source field of WorkflowStepInput.

OutputArraySchema
class OutputArraySchema
OutputEnumSchema
class OutputEnumSchema
OutputParameter
class OutputParameter
OutputRecordField
class OutputRecordField
OutputRecordSchema
class OutputRecordSchema
PrimitiveType
class PrimitiveType

Names of salad data types (based on Avro schema declarations).

RecordField
class RecordField

A field of a record.

RecordSchema
class RecordSchema
ResourceRequirement
class ResourceRequirement

Specify basic hardware resource requirements.

ScatterFeatureRequirement
class ScatterFeatureRequirement

Indicates that the workflow platform must support the scatter and scatterMethod fields of WorkflowStep.

ScatterMethod
class ScatterMethod

The scatter method, as described in workflow step scatter.

SchemaDefRequirement
class SchemaDefRequirement

This field consists of an array of type definitions which must be used when interpreting the inputs and outputs fields. When a type field contain a IRI, the implementation must check if the type is defined in schemaDefs and use that definition. If the type is not found in schemaDefs, it is an error. The entries in schemaDefs must be processed in the order listed such that later schema definitions may refer to earlier schema definitions.

ShellCommandRequirement
class ShellCommandRequirement

Modify the behavior of CommandLineTool to generate a single string containing a shell command line. Each item in the argument list must be joined into a string separated by single spaces and quoted to prevent intepretation by the shell, unless CommandLineBinding for that argument contains shellQuote: false. If shellQuote: false is specified, the argument is joined into the command string without quoting, which allows the use of shell metacharacters such as | for pipes.

SoftwarePackage
class SoftwarePackage
SoftwareRequirement
class SoftwareRequirement

A list of software packages that should be configured in the environment of the defined process.

StepInputExpressionRequirement
class StepInputExpressionRequirement

Indicate that the workflow platform must support the valueFrom field of WorkflowStepInput.

SubworkflowFeatureRequirement
class SubworkflowFeatureRequirement

Indicates that the workflow platform must support nested workflows in the run field of WorkflowStep.

UnionSchema
class UnionSchema
Workflow
class Workflow

A workflow describes a set of **steps** and the **dependencies** between those steps. When a step produces output that will be consumed by a second step, the first step is a dependency of the second step.

WorkflowOutputParameter
class WorkflowOutputParameter

Describe an output parameter of a workflow. The parameter must be connected to one or more parameters defined in the workflow that will provide the value of the output parameter.

WorkflowStep
class WorkflowStep

A workflow step is an executable element of a workflow. It specifies the underlying process implementation (such as CommandLineTool or another Workflow) in the run field and connects the input and output parameters of the underlying process to workflow parameters.

WorkflowStepInput
class WorkflowStepInput

The input of a workflow step connects an upstream parameter (from the workflow inputs, or the outputs of other workflows steps) with the input parameters of the underlying step.

WorkflowStepOutput
class WorkflowStepOutput

Associate an output parameter of the underlying process with a workflow parameter. The workflow parameter (given in the id field) be may be used as a source to connect with input parameters of other workflow steps, or with an output parameter of the process.

stderr
class stderr

Only valid as a type for a CommandLineTool output with no outputBinding set.

stdout
class stdout

Only valid as a type for a CommandLineTool output with no outputBinding set.

Imports

Any (from salad.primitives)
public import salad.primitives : Any;
Expression (from salad.primitives)
public import salad.primitives : Expression;

Manifest constants

parserInfo
enum parserInfo;

parser information

saladVersion
enum saladVersion;
Undocumented in source.

Mixin templates

genBody
mixintemplate genBody()
Undocumented in source.

Meta

License

Apache-2.0

Date

Date: 2024-09-26