通用工作流语言用户指南

这本指南将向您介绍使用 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 语言指南
    • 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. 网络访问 (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. 分散步骤
    • 2.10.4. 条件性工作流
  • 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. 教程
  • 3.1. 入门教程
  • 3.2. 进阶教程
  • 3.3. 生物信息学相关教程
• 4. 常见问题
  • 4.1. 如何用 evalFrom 创建非“File”类型？
  • 4.2. 如何重命名输入文件？
  • 4.3. 如何重命名输出文件？
  • 4.4. 如何引用本地脚本？
  • 4.5. 如何为可选输入项设置用到 self 变量的输入绑定？
  • 4.6. 如何构建“非此即彼”的参数？
  • 4.7. 如何将某个元素值与期待同一类型的数组关联起来？
  • 4.8. 如何使某个输入称为可选的？💯
  • 4.9. 如何让某个输入只能从一组固定的值中取一（即：如何使用枚举类型输入）？
  • 4.10. 如何描述彼此依存或互斥的输入参数（即：如何使用记录类型输入）？
  • 4.11. 如何设定互斥参数？
  • 4.12. 如何设置布尔参数？
  • 4.13. 在输入中串联多个字符串时该如何操作？
  • 4.14. 因文件名含有空格字符，cwltool报错，该怎么解决？
  • 4.15. 输入标识符中包含连字符造成 CWL 参数引用错误，如何解决？
  • 4.16. 如何在 Singularity 下使用 CWL 和 cwltool?
  • 4.17. 如何调试 CWL 工具中的 JavaScript 代码？
• 5. 许可协议
  • 5.1. 指南资料
  • 5.2. 软件