nfcore/kmermaid

nf-core/kmermaid Docker镜像

镜像概述和主要用途

nf-core/kmermaid是一个基于Nextflow构建的生物信息学工作流Docker镜像，核心功能是通过k-mer内容比较DNA、RNA和蛋白质序列。该镜像提供了标准化的运行环境，确保分析过程的可移植性和结果的高度可重复性，可在多种计算基础设施上运行。

!Workflow overview

核心功能和特性

• k-mer序列比较：支持DNA、RNA和蛋白质序列的k-mer内容比较分析
• 多输入格式支持：兼容fastq、fasta、bam文件及SRA ID等多种输入类型
• Nextflow工作流：基于Nextflow DSL2构建，支持跨计算基础设施的任务调度
• 容器化环境：提供完整的Docker容器，简化安装流程并确保环境一致性
• 可配置性：支持多种运行参数，如子采样、k-mer分割等高级分析选项

使用场景和适用范围

适用于需要对核酸或蛋白质序列进行k-mer特征比较的生物信息学分析场景，包括但不限于：

• 基因组/转录组序列相似性分析
• 宏基因组样本比较
• 序列特征提取与聚类
• 大规模序列数据集的快速比较

快速开始

前提条件

1. 安装https://nf-co.re/usage/installation%EF%BC%88%E7%89%88%E6%9C%AC%E2%89%A520.07.1%EF%BC%89
2. 安装Docker或Singularity（推荐使用Docker确保完整 reproducibility）

测试运行

bash
nextflow run nf-core/kmermaid -profile test,<docker/singularity/conda/institute>

可查看https://github.com/nf-core/configs#documentation%E8%8E%B7%E5%8F%96%E6%9C%BA%E6%9E%84%E7%89%B9%E5%AE%9A%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%EF%BC%8C%E4%BD%BF%E7%94%A8%60-profile `可自动配置本地计算环境

开始正式分析

bash
nextflow run nf-core/kmermaid -profile <docker/singularity/conda/institute> --input '*_R{1,2}.fastq.gz' --genome GRCh37

详细使用方法

输入格式示例

1. 使用samples.csv文件

bash
nextflow run nf-core/kmermaid --outdir s3://bucket/sub-bucket --samples samples.csv

2. 使用R1/R2读对

bash
nextflow run nf-core/kmermaid --outdir s3://olgabot-maca/nf-kmer-similarity/ \
  --read_pairs 's3://bucket/sub-bucket/*{R1,R2}*.fastq.gz,s3://bucket/sub-bucket2/*{1,2}.fastq.gz'

3. 使用SRA ID

bash
nextflow run nf-core/kmermaid --outdir s3://bucket/sub-bucket --sra SRP016501

4. 使用fasta文件

bash
nextflow run nf-core/kmermaid --outdir s3://bucket/sub-bucket \
  --fastas '*.fasta'

5. 使用bam文件

bash
nextflow run nf-core/kmermaid  --outdir s3://bucket/sub-bucket \
  --bam 'possorted_genome_bam.bam'

6. 带k-mer分割的分析

bash
nextflow run nf-core/kmermaid --outdir s3://bucket/sub-bucket --samples samples.csv --split_kmer --subsample 1000

文档和支持

完整文档

• https://nf-co.re/usage/installation
• 管道配置
  • https://nf-co.re/usage/local_installation
  • https://nf-co.re/usage/adding_own_config
  • https://nf-co.re/usage/reference_genomes
• 运行管道
• 输出结果解释
• https://nf-co.re/usage/troubleshooting

支持渠道

• Slack（通过https://nf-co.re/join/slack%E5%8A%A0%E5%85%A5%EF%BC%89

引用

使用nf-core/kmermaid进行分析时，请引用：

• DOI: https://zenodo.org/record/4143940

同时引用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: https://dx.doi.org/10.1038/s41587-020-0439-x.