Common Workflow Language ユーザーガイド

本ガイドは、オープンスタンダードである Common Workflow Language (CWL) を使用したワークフローの書き方を紹介するものです。本ガイドは、最新仕様v1.2を解説しています。

ご意見、ご感想、貢献をお待ちしております!

このガイドに足りないものがある場合、またはその他のフィードバックを提供したい場合は、このユーザーガイドのプロジェクトリポジトリにIssueを作成してください。また、各ページの右サイドバーにある「このページを編集する」ボタンをクリックすると、Pull Requestで直接変更を提案することができます。

ユーザーガイドの使い方

初心者の方は、はじめにのセクションから始めてください。上級者向けには、Topicsのサブセクションに、CWLで最も一般的なトピックに関する詳細情報があります。

目次は、トップメニューと左サイドバーに表示されています。また、このページのさらに下にも表示されますが、サブセクションへのリンクがあります。右サイドバーには各ページのセクションへのリンクがあり、左サイドバーには「検索フォーム」があります。

目次

• 1. はじめに
  • 1.1. クイックスタート
    • 1.1.1. "Hello World"
    • 1.1.2. CWL Runnerのインストール
    • 1.1.3. "Hello World"を実行する
    • 1.1.4. さらなる学習
  • 1.2. 前提条件
    • 1.2.1. オペレーティングシステム
    • 1.2.2. CWL Runner
    • 1.2.3. テキストエディタ
    • 1.2.4. Docker
    • 1.2.5. さらなる学習
  • 1.3. 基本コンセプト
    • 1.3.1. CWLの仕様
    • 1.3.2. 実装
    • 1.3.3. Processes 及び Requirements
    • 1.3.4. FAIRワークフロー
    • 1.3.5. さらなる学習
• 2. トピックス
  • 2.1. YAMLガイド
    • 2.1.1. 目次
    • 2.1.2. キーバリューペア
    • 2.1.3. コメント
    • 2.1.4. マップ
    • 2.1.5. 配列
    • 2.1.6. JSON形式
    • 2.1.7. リファレンス
  • 2.2. コマンドラインツール
    • 2.2.1. ネットワークアクセス
  • 2.3. Expressions
    • 2.3.1. expressionLib による外部ライブラリの利用とインラインJavaScriptコードの利用
  • 2.4. Inputs
    • 2.4.1. 必須入力パラメータ
    • 2.4.2. 配列入力
    • 2.4.3. 包括的入力と排他的入力
  • 2.5. 追加の引数とパラメータ
  • 2.6. パラメータリファレンス
  • 2.7. Outputs
    • 2.7.1. 出力ファイルの回収
    • 2.7.2. 標準出力をキャプチャする
    • 2.7.3. 出力の配列
  • 2.8. カスタムタイプ
  • 2.9. Expression Tool
  • 2.10. ワークフロー
    • 2.10.1. ワークフローを書く
    • 2.10.2. ネストされたワークフロー
    • 2.10.3. Scatter ステップ
    • 2.10.4. 条件分岐ワークフロー
  • 2.11. Operations
  • 2.12. 環境変数
  • 2.13. コンテナの使用
    • 2.13.1. Dockerの内部でツールを実行する
  • 2.14. 実行時にファイルを作成する
  • 2.15. 入力ファイルのステージング
  • 2.16. ベストプラクティス
  • 2.17. ファイルフォーマット
    • 2.17.1. サンプルパラメーターファイル
  • 2.18. メタデータと著者
    • 2.18.1. Extended Example
  • 2.19. ソフトウェア要求事項の指定
  • 2.20. トラブルシューティング
    • 2.20.1. cwltool をcachedir で実行する
• 3. チュートリアル
  • 3.1. 初心者向けチュートリアル
  • 3.2. 上級者向けチュートリアル
  • 3.3. バイオインフォマティクス・チュートリアル
• 4. よくある質問
  • 4.1. "File" 型をつかわず evalFromを使う方法
  • 4.2. 入力ファイルの名前を変更するにはどうしたらよいですか？
  • 4.3. 出力ファイルの名前を変更するにはどうしたらよいですか？
  • 4.4. ローカルスクリプトを参照するにはどうしたらよいですか？
  • 4.5. How can I set self-based input bindings for optional inputs?
  • 4.6. 「一か八か」のパラメータをモデル化するにはどうしたらよいですか?
  • 4.7. How do I connect a solo value to an input that expects an array of that type?
  • 4.8. 入力パラメータをオプショナルにするにはどうしたらよいですか? 💯
  • 4.9. どうやってあらかじめ定義された値のリストから入力を指定できますか(つまり、入力でenumを使うにはどうしたらよいですか)?
  • 4.10. 依存的または排他的な入力パラメータはどのように記述すればよいですか（例えば、レコード入力をどのように使用すればよいですか）？
  • 4.11. How do I set mutually exclusive parameters?
  • 4.12. ブール値を設定するにはどうしたらよいでしょうか？
  • 4.13. 入力された文字列を連結するにはどうしたら良いでしょうか？
  • 4.14. cwltool ファイル名の中に空白文字があるために起こるエラーにはどのように対処したらよいでしょうか？
  • 4.15. 入力パラメータ名の中のハイフンがあるため、CWLパラメータリファレンスエラーが起こりました。どのようしたらよいでしょうか？
  • 4.16. SingularityをCWLとcwltoolで使うにはどうしたらよいでしょうか？
  • 4.17. CWLツールのJavaScriptをデバッグするには?
• 5. ライセンス
  • 5.1. 指導資料
  • 5.2. ソフトウェア