Skip to content

Commit f49dc3e

Browse files
mr-cmr-c
authored
List where parameter references & expressions are allowed (#110)
and improve layout
1 parent f06fba5 commit f49dc3e

File tree

2 files changed

+102
-24
lines changed

2 files changed

+102
-24
lines changed

‎_episodes/06-params.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,54 @@ Note that because `File` parameters are objects, to get the path to an
8080
input file you must reference the path field on a file object; to
8181
reference the path to the tar file in the above example you would write
8282
`$(inputs.tarfile.path)`.
83+
84+
> ## Where are parameter references allowed?
85+
> You can only use parameter references in certain fields. These are:
86+
>
87+
> - From [`CommandLineTool`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineTool)
88+
> - `arguments`
89+
> - `valueFrom`
90+
> - `stdin`
91+
> - `stdout`
92+
> - `stderr`
93+
> - From [CommandInputParameter](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandInputParameter)
94+
> - `format`
95+
> - `secondaryFiles`
96+
> - From [`inputBinding`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineBinding)
97+
> - `valueFrom`
98+
> - From [CommandOutputParamater](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputParameter)
99+
> - `format`
100+
> - `secondaryFiles`
101+
> - From [CommandOutputBinding](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputBinding)
102+
> - `glob`
103+
> - `outputEval`
104+
> - From `Workflow`
105+
> - From [InputParameter](http://www.commonwl.org/v1.0/Workflow.html#InputParameter) and [WorkflowOutputParameter](http://www.commonwl.org/v1.0/Workflow.html#WorkflowOutputParameter)
106+
> - `format`
107+
> - `secondaryFiles`
108+
> - From `steps`
109+
> - From [WorkflowStepInput](http://www.commonwl.org/v1.0/Workflow.html#WorkflowStepInput)
110+
> - `valueFrom`
111+
> - From [ExpressionTool](https://www.commonwl.org/v1.0/Workflow.html#ExpressionTool)
112+
> - `expression`
113+
> - From [InputParameter](http://www.commonwl.org/v1.0/Workflow.html#InputParameter) and [ExpressionToolOutputParameter](http://www.commonwl.org/v1.0/Workflow.html#ExpressionToolOutputParameter)
114+
> - `format`
115+
> - `secondaryFiles`
116+
> - From [`ResourceRequirement`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
117+
> - `coresMin`
118+
> - `coresMax`
119+
> - `ramMin`
120+
> - `ramMax`
121+
> - `tmpdirMin`
122+
> - `tmpdirMax`
123+
> - `outdirMin`
124+
> - `outdirMax`
125+
> - From [`InitialWorkDirRequirement`](http://www.commonwl.org/v1.0/CommandLineTool.html#InitialWorkDirRequirement)
126+
> - `listing`
127+
> - in [Dirent](http://www.commonwl.org/v1.0/CommandLineTool.html#Dirent)
128+
> - `entry`
129+
> - `entryname`
130+
> - From `EnvVarRequirement`
131+
> - From [EnvironmentDef](http://www.commonwl.org/v1.0/CommandLineTool.html#EnvironmentDef)
132+
> - `envValue`
133+
{: .callout }

‎_episodes/13-expressions.md

Lines changed: 51 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -86,30 +86,57 @@ Note that requirements must be provided as an array, with each entry (in this
8686
case, only `class: InlineJavascriptRequirement`) marked by a `-`. The same
8787
syntax is used to describe the additional command line arguments.
8888

89-
You can only use expressions in certain fields. These are:
90-
91-
- [`arguments`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineTool)
92-
- [`coresMin`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
93-
- [`coresMax`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
94-
- [`entry`](http://www.commonwl.org/v1.0/CommandLineTool.html#Dirent)
95-
- [`entryname`](http://www.commonwl.org/v1.0/CommandLineTool.html#Dirent)
96-
- `format` (in a [CommandInputParameter](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandInputParameter), [CommandOutputParamater](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputParameter), [WorkflowOutputParameter](http://www.commonwl.org/v1.0/Workflow.html#WorkflowOutputParameter), or [ExpressionToolOutputParameter](http://www.commonwl.org/v1.0/Workflow.html#ExpressionToolOutputParameter))
97-
- [`expression`](http://www.commonwl.org/v1.0/Workflow.html#ExpressionTool)
98-
- [`envValue`](http://www.commonwl.org/v1.0/CommandLineTool.html#EnvironmentDef)
99-
- [`glob`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputBinding)
100-
- [`listing`](http://www.commonwl.org/v1.0/CommandLineTool.html#InitialWorkDirRequirement)
101-
- [`outdirMin`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
102-
- [`outdirMax`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
103-
- [`outputEval`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputBinding)
104-
- `secondaryFiles` (in a [CommandInputParameter](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandInputParameter), [CommandOutputParamater](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputParameter), [WorkflowOutputParameter](http://www.commonwl.org/v1.0/Workflow.html#WorkflowOutputParameter), or [ExpressionToolOutputParameter](http://www.commonwl.org/v1.0/Workflow.html#ExpressionToolOutputParameter))
105-
- [`ramMin`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
106-
- [`ramMax`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
107-
- [`stdin`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineTool)
108-
- [`stdout`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineTool)
109-
- [`stderr`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineTool)
110-
- [`tmpdirMin`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
111-
- [`tmpdirMax`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
112-
- `valueFrom` (in a [CommandLineBinding](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineBinding), or [WorkflowStepInput](http://www.commonwl.org/v1.0/Workflow.html#WorkflowStepInput))
89+
> ## Where are parameter references allowed?
90+
> Just like [parameter references]({{ page.root }}{% link _episodes/06-params.md %}), you can use JavaScript Expressions
91+
> only in certain fields. These are:
92+
>
93+
> - From [`CommandLineTool`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineTool)
94+
> - `arguments`
95+
> - `valueFrom`
96+
> - `stdin`
97+
> - `stdout`
98+
> - `stderr`
99+
> - From [CommandInputParameter](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandInputParameter)
100+
> - `format`
101+
> - `secondaryFiles`
102+
> - From [`inputBinding`](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandLineBinding)
103+
> - `valueFrom`
104+
> - From [CommandOutputParamater](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputParameter)
105+
> - `format`
106+
> - `secondaryFiles`
107+
> - From [CommandOutputBinding](http://www.commonwl.org/v1.0/CommandLineTool.html#CommandOutputBinding)
108+
> - `glob`
109+
> - `outputEval`
110+
> - From `Workflow`
111+
> - From [InputParameter](http://www.commonwl.org/v1.0/Workflow.html#InputParameter) and [WorkflowOutputParameter](http://www.commonwl.org/v1.0/Workflow.html#WorkflowOutputParameter)
112+
> - `format`
113+
> - `secondaryFiles`
114+
> - From `steps`
115+
> - From [WorkflowStepInput](http://www.commonwl.org/v1.0/Workflow.html#WorkflowStepInput)
116+
> - `valueFrom`
117+
> - From [ExpressionTool](https://www.commonwl.org/v1.0/Workflow.html#ExpressionTool)
118+
> - `expression`
119+
> - From [InputParameter](http://www.commonwl.org/v1.0/Workflow.html#InputParameter) and [ExpressionToolOutputParameter](http://www.commonwl.org/v1.0/Workflow.html#ExpressionToolOutputParameter)
120+
> - `format`
121+
> - `secondaryFiles`
122+
> - From [`ResourceRequirement`](http://www.commonwl.org/v1.0/CommandLineTool.html#ResourceRequirement)
123+
> - `coresMin`
124+
> - `coresMax`
125+
> - `ramMin`
126+
> - `ramMax`
127+
> - `tmpdirMin`
128+
> - `tmpdirMax`
129+
> - `outdirMin`
130+
> - `outdirMax`
131+
> - From [`InitialWorkDirRequirement`](http://www.commonwl.org/v1.0/CommandLineTool.html#InitialWorkDirRequirement)
132+
> - `listing`
133+
> - in [Dirent](http://www.commonwl.org/v1.0/CommandLineTool.html#Dirent)
134+
> - `entry`
135+
> - `entryname`
136+
> - From `EnvVarRequirement`
137+
> - From [EnvironmentDef](http://www.commonwl.org/v1.0/CommandLineTool.html#EnvironmentDef)
138+
> - `envValue`
139+
{: .callout }
113140

114141

115142
[file-prop]: http://www.commonwl.org/v1.0/CommandLineTool.html#File

0 commit comments

Comments
 (0)