Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

任务挑战赛-【赛题解读】T4:Bio-OS流程规范扩展 #22

Open
yifanchen90 opened this issue Oct 23, 2023 · 2 comments
Open

Comments

@yifanchen90
Copy link
Contributor

yifanchen90 commented Oct 23, 2023

背景介绍

Bio-OS 作为一个开源开放的生信分析平台,兼容 GA4GH 的 WES\TES 协议,为生物信息学研究提供了一个强大生物信息科研工具体系。然而,目前 Bio-OS 平台仅支持 WDL 语言作为其流程规范语言,这在一定程度上限制了用户的使用。为了进一步扩展 Bio-OS 平台的功能,本次大赛的主题是基于 WES 扩展 Bio-OS 平台支持的流程规范语言,请从 CWL、Nextflow 和 Snakemake 选择1种或者多种进行实现。

任务介绍

本次生物信息开发大赛的任务是基于GA4GH提出的WES规范(https://github.com/ga4gh/workflow-execution-service-schemas)设计并实现一个扩展方案,使 Bio-OS 平台能够支持多种流程规范语言。具体来说,参赛者需要完成以下任务:

  1. 熟悉 Bio-OS 平台的架构和工作原理,掌握其工作流管理和调度等功能。
  2. 了解 WES\TES 协议的基本原理和使用方法,掌握其与 Bio-OS 平台的集成方法。
  3. 了解 CWL、Nextflow 和 Snakemake 等流程规范语言的基本语法和语义,掌握其常用的命令和参数。
  4. 设计一个基于 WES 扩展 Bio-OS 平台支持的流程规范语言的方案,包括解析和转换流程规范语言、实现工作流管理和调度等功能。
  5. 实现扩展方案,包括编写相关的代码和配置文件、测试和调试等。
  6. 展示扩展后的 Bio-OS 平台的效果,包括使用新的流程规范语言提交工作流、监控和管理工作流等。

提交内容

请将以下提交内容发送到邮箱: bioosopensource@163.com

  1. 一个名称为"生信挑战-T4-队伍名称"的md或word文件
    (示例文档https://github.com/Bio-OS/bioos/blob/main/docs/static/%E6%96%B9%E6%A1%88%E8%AE%BE%E8%AE%A1%E6%A8%A1%E7%89%88.doc仅作为参考,非必须参照)
  • 对整体流程规范扩展的方案设计介绍
  • 扩展的工作流功能使用说明
  • 包含一个视频链接(如上传到B站或其他网站,附上链接,如视频不大也可以直接发送邮箱)
  1. 将源代码提交PR到https://github.com/Bio-OS/bioos中

评分标准

本次比赛的评分标准包括以下几个方面:

  1. 难度基础分(权重10%)
  • T1:Notebook插件可视化工具集成 --难度基础分6分
  • T2:实现工作流运行任务监控 -- 难度基础分8分
  • T3:命令行工具实现Bio-OS Notebook使用 -- 难度基础分8分
  • T4:Bio-OS流程规范扩展 -- 难度基础分 10分
  1. 方案设计:监控方案的合理性、完整性和可扩展性。(权重20%) (示例文档https://github.com/Bio-OS/bioos/blob/main/docs/static/%E6%96%B9%E6%A1%88%E8%AE%BE%E8%AE%A1%E6%A8%A1%E7%89%88.doc 仅作为参考,非必须参照)
  2. Demo效果:DEMO效果展示,Demo视频中可尽量展示完整的操作及参数配置及结果生成。(权重20%)
  3. 代码实现:通过提交的源代码进行code review,将从代码质量、可维护性、可读性多个维度进行评分。(权重30%)
  • 代码质量:是否正确的实现了预期功能和需求,是否处理了预期的错误情况并提供了清晰地错误消息和处理方式,是否考虑可配置参数
  • 可维护性:是否易于修改和维护,包括代码的模块化程度、复用性,是否易于扩展
  • 可读性:代码是否易于阅读和理解,包括变量名、函数名、注释等命名是否清晰,代码结构是否合理
  1. 文档编写(20%)
  • 内容准确性:是否准确、完整、清晰的表达了所需信息
  • 文档可读性:文档的结构是否合理,逻辑清晰,是否易于阅读和理解,是否使用了恰当的图表和图片等
@bytedance-oss-robot
Copy link

I think we can close this issue.

@bytedance-oss-robot
Copy link

@yifanchen90

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants