|
11 | 11 | output. CWL documents are written in [JSON](http://json.org) or
|
12 | 12 | [YAML](http://yaml.org), or a mix of the two.
|
13 | 13 |
|
14 |
| - *example-1st.cwl* |
| 14 | + *1st.cwl* |
15 | 15 | ```
|
16 |
| - - $include: examples/example-1st.cwl |
| 16 | + - $include: examples/1st.cwl |
17 | 17 | - |
|
18 | 18 | ```
|
19 | 19 |
|
20 | 20 | Use a JSON object in a separate file to describe the input of a run:
|
21 | 21 |
|
22 |
| - *example-echo-job.json* |
| 22 | + *echo-job.json* |
23 | 23 | ```
|
24 |
| - - $include: examples/example-echo-job.json |
| 24 | + - $include: examples/echo-job.json |
25 | 25 | - |
|
26 | 26 | ```
|
27 | 27 |
|
|
88 | 88 | types and appearing on the command line in different ways:
|
89 | 89 |
|
90 | 90 |
|
91 |
| - *example-inp.cwl* |
| 91 | + *inp.cwl* |
92 | 92 | ```
|
93 |
| - - $include: examples/example-inp.cwl |
| 93 | + - $include: examples/inp.cwl |
94 | 94 | - |
|
95 | 95 | ```
|
96 | 96 |
|
97 |
| - *example-inp-job.json* |
| 97 | + *inp-job.json* |
98 | 98 | ```
|
99 |
| - - $include: examples/example-inp-job.json |
| 99 | + - $include: examples/inp-job.json |
100 | 100 | - |
|
101 | 101 | ```
|
102 | 102 |
|
|
203 | 203 | output parameters returned by the CWL tool are either the output files
|
204 | 204 | themselves, or come from examining the content of those files.
|
205 | 205 |
|
206 |
| - *example-tar.cwl* |
| 206 | + *tar.cwl* |
207 | 207 | ```
|
208 |
| - - $include: examples/example-tar.cwl |
| 208 | + - $include: examples/tar.cwl |
209 | 209 | - |
|
210 | 210 | ```
|
211 | 211 |
|
212 |
| - *example-tar-job.json* |
| 212 | + *tar-job.json* |
213 | 213 | ```
|
214 |
| - - $include: examples/example-tar-job.json |
| 214 | + - $include: examples/tar-job.json |
215 | 215 | - |
|
216 | 216 | ```
|
217 | 217 |
|
|
253 | 253 | the name of the file where the output stream should go. Then use `glob`
|
254 | 254 | on `outputBinding` to return the file.
|
255 | 255 |
|
256 |
| - *example-stdout.cwl* |
| 256 | + *stdout.cwl* |
257 | 257 | ```
|
258 |
| - - $include: examples/example-stdout.cwl |
| 258 | + - $include: examples/stdout.cwl |
259 | 259 | - |
|
260 | 260 | ```
|
261 | 261 |
|
262 |
| - *example-echo-job.json* |
| 262 | + *echo-job.json* |
263 | 263 | ```
|
264 |
| - - $include: examples/example-echo-job.json |
| 264 | + - $include: examples/echo-job.json |
265 | 265 | - |
|
266 | 266 | ```
|
267 | 267 |
|
|
293 | 293 | see how to reference the value of input parameters dynamically from other
|
294 | 294 | fields.
|
295 | 295 |
|
296 |
| - *example-tar-param.cwl* |
| 296 | + *tar-param.cwl* |
297 | 297 | ```
|
298 |
| - - $include: examples/example-tar-param.cwl |
| 298 | + - $include: examples/tar-param.cwl |
299 | 299 | - |
|
300 | 300 | ```
|
301 | 301 |
|
302 |
| - *example-tar-param-job.json* |
| 302 | + *tar-param-job.json* |
303 | 303 | ```
|
304 |
| - - $include: examples/example-tar-param-job.json |
| 304 | + - $include: examples/tar-param-job.json |
305 | 305 | - |
|
306 | 306 | ```
|
307 | 307 |
|
|
359 | 359 |
|
360 | 360 | This example runs a simple Node.js script inside a Docker container.
|
361 | 361 |
|
362 |
| - *example-docker.cwl* |
| 362 | + *docker.cwl* |
363 | 363 | ```
|
364 |
| - - $include: examples/example-docker.cwl |
| 364 | + - $include: examples/docker.cwl |
365 | 365 | - |
|
366 | 366 | ```
|
367 | 367 |
|
368 |
| - *example-docker-job.json* |
| 368 | + *docker-job.json* |
369 | 369 | ```
|
370 |
| - - $include: examples/example-docker-job.json |
| 370 | + - $include: examples/docker-job.json |
371 | 371 | - |
|
372 | 372 | ```
|
373 | 373 |
|
|
402 | 402 | instruct javac to write the class file to the designated output directory
|
403 | 403 | instead.
|
404 | 404 |
|
405 |
| - *example-arguments.cwl* |
| 405 | + *arguments.cwl* |
406 | 406 | ```
|
407 |
| - - $include: examples/example-arguments.cwl |
| 407 | + - $include: examples/arguments.cwl |
408 | 408 | - |
|
409 | 409 | ```
|
410 | 410 |
|
411 |
| - *example-arguments-job.json* |
| 411 | + *arguments-job.json* |
412 | 412 | ```
|
413 |
| - - $include: examples/example-arguments-job.json |
| 413 | + - $include: examples/arguments-job.json |
414 | 414 | - |
|
415 | 415 | ```
|
416 | 416 |
|
|
458 | 458 | under the `type` field with `type: array` and `items` defining the valid
|
459 | 459 | data types that may appear in the array.
|
460 | 460 |
|
461 |
| - *example-array.cwl* |
| 461 | + *array.cwl* |
462 | 462 | ```
|
463 |
| - - $include: examples/example-array.cwl |
| 463 | + - $include: examples/array.cwl |
464 | 464 | - |
|
465 | 465 | ```
|
466 | 466 |
|
467 |
| - *example-array-job.json* |
| 467 | + *array-job.json* |
468 | 468 | ```
|
469 |
| - - $include: examples/example-array-job.json |
| 469 | + - $include: examples/array-job.json |
470 | 470 | - |
|
471 | 471 | ```
|
472 | 472 |
|
|
500 | 500 | provided together (they are exclusive). You can use records and type
|
501 | 501 | unions to group parameters together to describe these two conditions.
|
502 | 502 |
|
503 |
| - *example-record.cwl* |
| 503 | + *record.cwl* |
504 | 504 | ```
|
505 |
| - - $include: examples/example-record.cwl |
| 505 | + - $include: examples/record.cwl |
506 | 506 | - |
|
507 | 507 | ```
|
508 | 508 |
|
509 |
| - *example-record-job1.json* |
| 509 | + *record-job1.json* |
510 | 510 | ```
|
511 |
| - - $include: examples/example-record-job1.json |
| 511 | + - $include: examples/record-job1.json |
512 | 512 | - |
|
513 | 513 | ```
|
514 | 514 |
|
|
521 | 521 |
|
522 | 522 | In the first example, you can't provide `itemA` without also providing `itemB`.
|
523 | 523 |
|
524 |
| - *example-record-job2.json* |
| 524 | + *record-job2.json* |
525 | 525 | ```
|
526 |
| - - $include: examples/example-record-job2.json |
| 526 | + - $include: examples/record-job2.json |
527 | 527 | - |
|
528 | 528 | ```
|
529 | 529 |
|
|
538 | 538 | In the second example, `itemC` and `itemD` are exclusive, so only `itemC`
|
539 | 539 | is added to the command line and `itemD` is ignored.
|
540 | 540 |
|
541 |
| - *example-record-job3.json* |
| 541 | + *record-job3.json* |
542 | 542 | ```
|
543 |
| - - $include: examples/example-record-job2.json |
| 543 | + - $include: examples/record-job2.json |
544 | 544 | - |
|
545 | 545 | ```
|
546 | 546 |
|
|
562 | 562 | variables from the parent process. You can set environment variables for
|
563 | 563 | the tool using `EnvVarRequirement`.
|
564 | 564 |
|
565 |
| - *example-env.cwl* |
| 565 | + *env.cwl* |
566 | 566 | ```
|
567 |
| - - $include: examples/example-env.cwl |
| 567 | + - $include: examples/env.cwl |
568 | 568 | - |
|
569 | 569 | ```
|
570 | 570 |
|
571 |
| - *example-echo-job.json* |
| 571 | + *echo-job.json* |
572 | 572 | ```
|
573 |
| - - $include: examples/example-echo-job.json |
| 573 | + - $include: examples/echo-job.json |
574 | 574 | - |
|
575 | 575 | ```
|
576 | 576 |
|
|
595 | 595 | legal you can provide a fragment of Javascript that will be evaluated by
|
596 | 596 | the CWL runner.
|
597 | 597 |
|
598 |
| - *example-expression.cwl* |
| 598 | + *expression.cwl* |
599 | 599 | ```
|
600 |
| - - $include: examples/example-expression.cwl |
| 600 | + - $include: examples/expression.cwl |
601 | 601 | - |
|
602 | 602 | ```
|
603 | 603 |
|
|
622 | 622 | rather than the command line parameters. To do this, use
|
623 | 623 | `CreateFileRequirement`.
|
624 | 624 |
|
625 |
| - *example-createfile.cwl* |
| 625 | + *createfile.cwl* |
626 | 626 | ```
|
627 |
| - - $include: examples/example-createfile.cwl |
| 627 | + - $include: examples/createfile.cwl |
628 | 628 | - |
|
629 | 629 | ```
|
630 | 630 |
|
631 |
| - *example-echo-job.json* |
| 631 | + *echo-job.json* |
632 | 632 | ```
|
633 |
| - - $include: examples/example-echo-job.json |
| 633 | + - $include: examples/echo-job.json |
634 | 634 | - |
|
635 | 635 | ```
|
636 | 636 |
|
|
655 | 655 | output directory. In this example, we use a Javascript expression to
|
656 | 656 | extract the base name of the input file from its leading directory path.
|
657 | 657 |
|
658 |
| - *example-linkfile.cwl* |
| 658 | + *linkfile.cwl* |
659 | 659 | ```
|
660 |
| - - $include: examples/example-linkfile.cwl |
| 660 | + - $include: examples/linkfile.cwl |
661 | 661 | - |
|
662 | 662 | ```
|
663 | 663 |
|
664 |
| - *example-arguments-job.json* |
| 664 | + *arguments-job.json* |
665 | 665 | ```
|
666 |
| - - $include: examples/example-arguments-job.json |
| 666 | + - $include: examples/arguments-job.json |
667 | 667 | - |
|
668 | 668 | ```
|
669 | 669 |
|
|
0 commit comments