通用工作流语言用户指南

这本指南将向您介绍使用 Common Workflow Language (CWL) 开放标准编写工作流。本指南所描述的是 v1.2 版本最新规范。

欢迎您的来稿和意见！

如您发现本指南的疏漏之处，或想提供其他反馈，请在本指南项目源码库上提交报告 (Issue). 您也可在任意页面点击右边栏的 “Edit this page”（编辑本页）按钮，创建 Pull Request（拉取请求）直接提交修改建议。

浏览《用户指南》

如您是新用户，请从 《入门》 章节出发。而对于进阶用户而言， 《主题》部分各小节涵盖了关于 CWL 最常见话题的详细信息。

目录显示在顶部菜单和左侧边栏，本页更下方也有带小节链接的目录。右侧边栏有当前单页分节链接，搜索功能在左侧边栏。

目录

• 1. 概述
  • 1.1. 快速入门
    • 1.1.1. “Hello World”（“世界您好”程序）
    • 1.1.2. 安装 CWL 运行程序
    • 1.1.3. 运行“Hello World”
    • 1.1.4. 了解更多信息
  • 1.2. 学习前的准备
    • 1.2.1. 操作系统
    • 1.2.2. CWL 运行程序
    • 1.2.3. 文本编辑器
    • 1.2.4. Docker
    • 1.2.5. 了解更多信息
  • 1.3. 基本概念
    • 1.3.1. CWL 规约
    • 1.3.2. 实现
    • 1.3.3. 流程和要求
    • 1.3.4. FAIR 工作流
    • 1.3.5. 了解更多信息
• 2. 主题
  • 2.1. YAML Guide
    • 2.1.1. Contents
    • 2.1.2. Key-Value Pairs
    • 2.1.3. Comments
    • 2.1.4. Maps
    • 2.1.5. Arrays
    • 2.1.6. JSON Style
    • 2.1.7. Reference
  • 2.2. 命令行工具
    • 2.2.1. 网络访问 (Network Access)
  • 2.3. 表达式
    • 2.3.1. 通过 expressionLib 使用外部库和内联 JavaScript 代码
  • 2.4. 输入 (inputs)
    • 2.4.1. 基本输入参数
    • 2.4.2. 数组输入
    • 2.4.3. 相容和互斥输入
  • 2.5. 附加参数
  • 2.6. 参数引用
  • 2.7. 输出
    • 2.7.1. 返回输出文件
    • 2.7.2. 捕获标准输出
    • 2.7.3. 数组输出
  • 2.8. 自定义类型
  • 2.9. 表达式工具
  • 2.10. 工作流
    • 2.10.1. 编写工作流
    • 2.10.2. 嵌套的工作流
    • 2.10.3. Scattering Steps
    • 2.10.4. Conditional Workflows
  • 2.11. 抽象操作
  • 2.12. 环境变量
  • 2.13. 使用容器
    • 2.13.1. 在 Docker 中运行工具
  • 2.14. 在运行时创建文件
  • 2.15. 暂存输入文件
  • 2.16. 优良习惯
  • 2.17. 文件格式
    • 2.17.1. 参数文件样本
  • 2.18. 元数据和著作人信息
    • 2.18.1. 进一步扩展的例子
  • 2.19. 指定软件需求
  • 2.20. 故障排除
    • 2.20.1. 制定 cachedir（缓存目录）运行 cwltool
• 3. Tutorials
  • 3.1. Beginner Tutorials
  • 3.2. Advanced Tutorials
  • 3.3. Bioinformatics Tutorials
• 4. 常见问题
  • 4.1. How do I create non “File” types using evalFrom?
  • 4.2. How do I rename an input file?
  • 4.3. How do I rename an output file?
  • 4.4. How do I reference a local script?
  • 4.5. How can I set self-based input bindings for optional inputs?
  • 4.6. How can I model a “one-or-the-other” parameter?
  • 4.7. How do I connect a solo value to an input that expects an array of that type?
  • 4.8. How do make an input optional? 💯
  • 4.9. How do I specify an input that must come from a list of predefined values (i.e. How do I use enum inputs) ?
  • 4.10. How do I describe dependent or exclusive input parameters(e.g. How do I use record inputs)?
  • 4.11. How do I set mutually exclusive parameters?
  • 4.12. How can I set Booleans?
  • 4.13. What should I do when concatenating strings in inputs?
  • 4.14. I get cwltool errors due to filenames with space characters inside. What should I do?
  • 4.15. What should I do when I get CWL Parameter Reference error due to hyphen in an input identifier?
  • 4.16. How do I use CWL and cwltool with Singularity?
  • 4.17. How do I debug the JavaScript in my CWL tool?
• 5. 许可协议
  • 5.1. 指南资料
  • 5.2. 软件