Update 02-1st-example.md #80
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I added extra explanations about echo and the contents of the files the tutorial user should make, and the command they will execute. I simplified the text about 'use a YAML or JSON object in a separate file' as it is very opaque to a beginner and didn't seem immediately relevant. I included an explanation of how the specific command used here (cwl-runner 1st-tool.cwl echo-job.yml) is an example of the general form cwl-runner [tool-or-workflow-description] [input-job-settings].
ghost
previously approved these changes
Oct 17, 2018
_episodes/02-1st-example.md
Outdated
|
|
||
| *echo-job.yml* | ||
| ~~~ | ||
| {% include cwl/02-1st-example/echo-job.yml %} | ||
| ~~~ | ||
| {: .source} | ||
|
|
||
| Now, invoke `cwl-runner` with the tool wrapper and the input object on the command line: | ||
| Now, invoke `cwl-runner` with the tool wrapper 1st-too.cwl and the input object echo-job.yml on the command line. The command is |
There was a problem hiding this comment.
Suggested change
| Now, invoke `cwl-runner` with the tool wrapper 1st-too.cwl and the input object echo-job.yml on the command line. The command is | |
| Now, invoke `cwl-runner` with the tool wrapper `1st-tool.cwl` and the input object `echo-job.yml` on the command line. The command is |
_episodes/02-1st-example.md
Outdated
| The command `cwl-runner 1st-tool.cwl echo-job.yml` is an example of a general form that you will often come across while using CWL. The general form is: | ||
| `cwl-runner [tool-or-workflow-description] [input-job-settings]` | ||
|
|
||
| What's going on here? Let's break down the contents of 1st-tool.cwl: |
There was a problem hiding this comment.
Suggested change
| What's going on here? Let's break down the contents of 1st-tool.cwl: | |
| What's going on here? Let's break down the contents of `1st-tool.cwl`: |
_episodes/02-1st-example.md
Outdated
| @@ -60,7 +64,7 @@ baseCommand: echo | |||
| ~~~ | |||
| {: .source} | |||
|
|
|||
| The `baseCommand` provides the name of program that will actually run (`echo`) | |||
| The `baseCommand` provides the name of program that will actually run (`echo`). [echo] is a built-in program in the bash and C shells. | |||
There was a problem hiding this comment.
Suggested change
| The `baseCommand` provides the name of program that will actually run (`echo`). [echo] is a built-in program in the bash and C shells. | |
| The `baseCommand` provides the name of program that will actually run (`[echo]` in this case, which is a built-in program in the bash and C shells). |
|
@rmccole could you please look at the suggestions? Otherwise the PR looks great. |
ghost
dismissed
their
ghost
previously approved these changes
Oct 19, 2018
mr-c
approved these changes
Oct 19, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I added extra explanations about echo and the contents of the files the tutorial user should make, and the command they will execute.
I simplified the text about 'use a YAML or JSON object in a separate file' as it is very opaque to a beginner and didn't seem immediately relevant.
I included an explanation of how the specific command used here (cwl-runner 1st-tool.cwl echo-job.yml) is an example of the general form cwl-runner [tool-or-workflow-description] [input-job-settings].