Skip to content

Categorize the examples for each section #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 7, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _episodes/02-1st-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ The simplest "hello world" program. This accepts one input parameter, writes a

*1st-tool.cwl*
~~~
{% include cwl/1st-tool.cwl %}
{% include cwl/02-1st-example/1st-tool.cwl %}
~~~
{: .source}

Use a YAML or JSON object in a separate file to describe the input of a run:

*echo-job.yml*
~~~
{% include cwl/echo-job.yml %}
{% include cwl/02-1st-example/echo-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/03-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ types and appearing on the command line in different ways:
*inp.cwl*

~~~
{% include cwl/inp.cwl %}
{% include cwl/03-input/inp.cwl %}
~~~
{: .source}

*inp-job.yml*

~~~
{% include cwl/inp-job.yml %}
{% include cwl/03-input/inp-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/04-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@ themselves, or come from examining the content of those files.
*tar.cwl*

~~~
{% include cwl/tar.cwl %}
{% include cwl/04-output/tar.cwl %}
~~~
{: .source}

*tar-job.yml*

~~~
{% include cwl/tar-job.yml %}
{% include cwl/04-output/tar-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/05-stdout.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ stdout` on the corresponding output parameter.
*stdout.cwl*

~~~
{% include cwl/stdout.cwl %}
{% include cwl/05-stdout/stdout.cwl %}
~~~
{: .source}

*echo-job.yml*

~~~
{% include cwl/echo-job.yml %}
{% include cwl/05-stdout/echo-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/06-params.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ fields.
*tar-param.cwl*

~~~
{% include cwl/tar-param.cwl %}
{% include cwl/06-params/tar-param.cwl %}
~~~
{: .source}

*tar-param-job.yml*

~~~
{% include cwl/tar-param-job.yml %}
{% include cwl/06-params/tar-param-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/07-containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ This example runs a simple Node.js script inside a Docker container.
*docker.cwl*

~~~
{% include cwl/docker.cwl %}
{% include cwl/07-containers/docker.cwl %}
~~~
{: .source}

*docker-job.yml*

~~~
{% include cwl/docker-job.yml %}
{% include cwl/07-containers/docker-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/08-arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ instead.
*arguments.cwl*

~~~
{% include cwl/arguments.cwl %}
{% include cwl/08-arguments/arguments.cwl %}
~~~
{: .source}

*arguments-job.yml*

~~~
{% include cwl/arguments-job.yml %}
{% include cwl/08-arguments/arguments-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/09-array-inputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ data types that may appear in the array.
*array-inputs.cwl*

~~~
{% include cwl/array-inputs.cwl %}
{% include cwl/09-array-inputs/array-inputs.cwl %}
~~~
{: .source}

*array-inputs-job.yml*

~~~
{% include cwl/array-inputs-job.yml %}
{% include cwl/09-array-inputs/array-inputs-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/10-array-outputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ You can also capture multiple output files into an array of files using `glob`.
*array-outputs.cwl*

~~~
{% include cwl/array-outputs.cwl %}
{% include cwl/10-array-outputs/array-outputs.cwl %}
~~~
{: .source}

*array-outputs-job.yml*

~~~
{% include cwl/array-outputs-job.yml %}
{% include cwl/10-array-outputs/array-outputs-job.yml %}
~~~
{: .source}

Expand Down
8 changes: 4 additions & 4 deletions _episodes/11-records.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ parameters together to describe these two conditions.
*record.cwl*

~~~
{% include cwl/record.cwl %}
{% include cwl/11-records/record.cwl %}
~~~
{: .source}

*record-job1.yml*

~~~
{% include cwl/record-job1.yml %}
{% include cwl/11-records/record-job1.yml %}
~~~
{: .source}

Expand All @@ -43,7 +43,7 @@ In the first example, you can't provide `itemA` without also providing `itemB`.
*record-job2.yml*

~~~
{% include cwl/record-job2.yml %}
{% include cwl/11-records/record-job2.yml %}
~~~
{: .source}

Expand All @@ -62,7 +62,7 @@ is added to the command line and `itemD` is ignored.
*record-job3.yml*

~~~
{% include cwl/record-job3.yml %}
{% include cwl/11-records/record-job3.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/12-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ the tool using `EnvVarRequirement`.
*env.cwl*

~~~
{% include cwl/env.cwl %}
{% include cwl/12-env/env.cwl %}
~~~
{: .source}

*echo-job.yml*

~~~
{% include cwl/echo-job.yml %}
{% include cwl/12-env/echo-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/13-expressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ See the [list of recommended practices][rec-practices].__
*expression.cwl*

~~~
{% include cwl/expression.cwl %}
{% include cwl/13-expressions/expression.cwl %}
~~~
{: .source}

Expand All @@ -37,7 +37,7 @@ job file:
*empty.yml*

~~~
{% include cwl/empty.yml %}
{% include cwl/13-expressions/empty.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/14-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ rather than the command line parameters. To do this, use
*createfile.cwl*

~~~
{% include cwl/createfile.cwl %}
{% include cwl/14-runtime/createfile.cwl %}
~~~
{: .source}

*echo-job.yml*

~~~
{% include cwl/echo-job.yml %}
{% include cwl/14-runtime/echo-job.yml %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/15-staging.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ input file from its leading directory path.
*linkfile.cwl*

~~~
{% include cwl/linkfile.cwl %}
{% include cwl/15-staging/linkfile.cwl %}
~~~
{: .source}

*arguments-job.yml*

~~~
{% include cwl/arguments-job.yml %}
{% include cwl/15-staging/arguments-job.yml %}
~~~
{: .source}

Expand Down
10 changes: 5 additions & 5 deletions _episodes/16-file-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ formats and warn you if there seem to be some obvious mismatches.
*metadata_example.cwl*

~~~
{% include cwl/metadata_example.cwl %}
{% include cwl/16-file-formats/metadata_example.cwl %}
~~~
{: .source}

Expand All @@ -42,15 +42,15 @@ parameterization.
*sample.json*

~~~
{% include cwl/sample.yml %}
{% include cwl/16-file-formats/sample.yml %}
~~~
{: .source}

___Note:___ To follow the example below, you need to download the example input file, *file-formats.bam*. The file is available from [https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/file-formats.bam
](https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/file-formats.bam) and can be downloaded e.g. via `wget`:
___Note:___ To follow the example below, you need to download the example input file, *file-formats.bam*. The file is available from [https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/16-file-formats/file-formats.bam
](https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/16-file-formats/file-formats.bam) and can be downloaded e.g. via `wget`:

~~~
wget https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/file-formats.bam
wget https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/16-file-formats/file-formats.bam
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/17-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ and workflows. This example includes metadata allowing others to cite your tool.
*metadata_example2.cwl*

~~~
{% include cwl/metadata_example2.cwl %}
{% include cwl/17-metadata/metadata_example2.cwl %}
~~~
{: .source}

Expand All @@ -40,7 +40,7 @@ requirements in order to use the tool, and a few more metadata fields.
*metadata_example3.cwl*

~~~
{% include cwl/metadata_example3.cwl %}
{% include cwl/17-metadata/metadata_example3.cwl %}
~~~
{: .source}

Expand Down
6 changes: 3 additions & 3 deletions _episodes/19-custom-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ It is a good example of a number of good practices in CWL.
*custom-types.cwl*

~~~
{% include cwl/custom-types.cwl %}
{% include cwl/19-custom-types/custom-types.cwl %}
~~~
{: .source}

*custom-types.yml*

~~~
{% include cwl/custom-types.yml %}
{% include cwl/19-custom-types/custom-types.yml %}
~~~
{: .source}

Expand Down Expand Up @@ -64,7 +64,7 @@ type from the imported `InterProScan-apps.yaml` file
The contents of the YAML file describing the custom type are given below:

~~~
{% include cwl/InterProScan-apps.yml %}
{% include cwl/19-custom-types/InterProScan-apps.yml %}
~~~
{: .source}

Expand Down
2 changes: 1 addition & 1 deletion _episodes/20-software-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This may also help to avoid confusion about which version of a tool the
description was written for.

~~~
{% include cwl/custom-types.cwl %}
{% include cwl/20-software-requirements/custom-types.cwl %}
~~~
{: .source}

Expand Down
4 changes: 2 additions & 2 deletions _episodes/21-1st-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ compiles it.
*1st-workflow.cwl*

~~~
{% include cwl/1st-workflow.cwl %}
{% include cwl/21-1st-workflow/1st-workflow.cwl %}
~~~
{: .source}

Expand All @@ -29,7 +29,7 @@ Use a JSON object in a separate file to describe the input of a run:
*1st-workflow-job.yml*

~~~
{% include cwl/1st-workflow-job.yml %}
{% include cwl/21-1st-workflow/1st-workflow-job.yml %}
~~~
{: .source}

Expand Down
2 changes: 1 addition & 1 deletion _episodes/22-nested-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Here's an example workflow that uses our `1st-workflow.cwl` as a nested
workflow:

~~~
{% include cwl/nestedworkflows.cwl %}
{% include cwl/22-nested-workflows/nestedworkflows.cwl %}
~~~
{: .source}

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions _includes/cwl/05-stdout/echo-job.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
message: Hello world!
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions _includes/cwl/12-env/echo-job.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
message: Hello world!
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions _includes/cwl/14-runtime/echo-job.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
message: Hello world!
1 change: 1 addition & 0 deletions _includes/cwl/15-staging/Hello.java
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
public class Hello {}
3 changes: 3 additions & 0 deletions _includes/cwl/15-staging/arguments-job.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
src:
class: File
path: Hello.java
File renamed without changes.
File renamed without changes.
Loading