一个用于托管 Nextflow DSL2 模块文件的仓库，其中包含特定工具的流程定义及其相关文档。

目录

• 使用现有模块
• 添加新模块
• 帮助
• 引用

使用现有模块

本仓库中托管的模块文件为 fastqc、bwa、samtools 等软件工具定义了一组流程。这允许您以模块化的方式在多个流水线中共享和添加通用功能。

我们在 nf-core/tools 包中编写了一个辅助命令，该命令使用 GitHub API 获取本仓库 modules/ 目录中现有模块文件的相关信息。这包括使用 git 提交哈希值来跟踪更改以实现可重复性，并下载和安装所有相关的模块文件。

1. 安装 nf-core/tools 的最新版本（>=2.0）
2. 列出可用模块：

$ nf-core modules list remote

                                      ,--./,-.
      ___     __   __   __   ___     /,-._.--~\
|\ | |__  __ /  ` /  \ |__) |__         }  {
| \| |       \__, \__/ |  \ |___     \`-._,-`-,
                                      `._,._,'

nf-core/tools version 2.0

INFO     Modules available from nf-core/modules (master):                       pipeline_modules.py:164

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Module Name                    ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ bandage/image                  │
│ bcftools/consensus             │
│ bcftools/filter                │
│ bcftools/isec                  │
..truncated..

3. 在您的管道目录中安装该模块：

$ nf-core modules install fastqc

                                      ,--./,-.
      ___     __   __   __   ___     /,-._.--~\
|\ | |__  __ /  ` /  \ |__) |__         }  {
| \| |       \__, \__/ |  \ |___     \`-._,-`-,
                                      `._,._,'

nf-core/tools version 2.0

INFO     Installing fastqc                                                      pipeline_modules.py:213
INFO     Downloaded 3 files to ./modules/nf-core/modules/fastqc                 pipeline_modules.py:236

4. 在您的 Nextflow 脚本中导入该模块：

#!/usr/bin/env nextflow

nextflow.enable.dsl = 2

include { FASTQC } from './modules/nf-core/modules/fastqc/main'

5. 如有需要，从流水线仓库中移除该模块：

$ nf-core modules remove fastqc

                                      ,--./,-.
      ___     __   __   __   ___     /,-._.--~\
|\ | |__  __ /  ` /  \ |__) |__         }  {
| \| |       \__, \__/ |  \ |___     \`-._,-`-,
                                      `._,._,'

nf-core/tools version 2.0

INFO     Removing fastqc                                                        pipeline_modules.py:271
INFO     Successfully removed fastqc                                            pipeline_modules.py:285

6. 检查本地安装的 nf-core 模块是否比托管在此仓库中的版本更新：

$ nf-core modules lint fastqc

                                      ,--./,-.
      ___     __   __   __   ___     /,-._.--~\
|\ | |__  __ /  ` /  \ |__) |__         }  {
| \| |       \__, \__/ |  \ |___     \`-._,-`-,
                                      `._,._,'

nf-core/tools version 2.0

INFO     Linting pipeline: .                                                    lint.py:104
INFO     Linting module: fastqc                                                 lint.py:106

╭─────────────────────────────────────────────────────────────────────────────────╮
│ [!] 1 Test Warning                                                              │
╰─────────────────────────────────────────────────────────────────────────────────╯
╭──────────────┬───────────────────────────────┬──────────────────────────────────╮
│ Module name  │ Test message                  │ File path                        │
├──────────────┼───────────────────────────────┼──────────────────────────────────┤
│ fastqc       │ Local copy of module outdated │ modules/nf-core/modules/fastqc/  │
╰──────────────┴────────────────────────────── ┴──────────────────────────────────╯
╭──────────────────────╮
│ LINT RESULTS SUMMARY │
├──────────────────────┤
│ [✔]  15 Tests Passed │
│ [!]   1 Test Warning │
│ [✗]   0 Test Failed  │
╰──────────────────────╯

添加新模块

如果您希望贡献一个新模块，请参阅 nf-core 网站 上的文档。

请善待我们的代码审查者，每个模块提交一个拉取请求 :)

帮助

如需更多信息或帮助，请随时通过 Slack #modules 频道 与我们联系（您可以使用 此邀请 加入）。

引用

如果您在分析中使用了本仓库中的模块文件，您可以引用 nf-core 出版物，如下所示：

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.

CI 运行器

我们使用自托管运行器进行 CI 测试，通过 RunsOn 进行管理。