ITADN
nf-core/taxprofiler
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

nf-core/taxprofiler

Open in GitHub Codespaces GitHub Actions CI Status GitHub Actions Linting StatusAWS CICite with Zenodo nf-test

Nextflow nf-core template version run with conda run with docker run with singularity Launch on Seqera Platform

Get help on SlackFollow on BlueskyFollow on MastodonWatch on YouTube

Cite Preprint

简介

nf-core/taxprofiler 是一个用于鸟枪法短读长和长读长宏基因组数据分类学分类与谱系分析的生物信息学最佳实践分析流程。它支持并行地对 reads 进行分类学鉴定,或使用多种分类和谱系分析工具针对多个数据库进行分类学丰度估算,并生成标准化的输出表格,以便于在不同工具和数据库之间比较结果。

流程概述

  1. Read QC (FastQC or falco as an alternative option)
  2. Performs optional read pre-processing
  3. Supports statistics metagenome coverage estimation (Nonpareil) and for host-read removal (Samtools)
  4. Performs taxonomic classification and/or profiling using one or more of:
  5. Perform optional post-processing with:
  6. Standardises output tables (Taxpasta)
  7. Present QC for raw reads (MultiQC)
  8. Plotting Kraken2, Centrifuge, Kaiju and MALT results (Krona)

用法

[!NOTE] 如果您是 Nextflow 和 nf-core 的新手,请参阅 此页面 了解如何设置 Nextflow。在运行工作流处理实际数据之前,请确保使用 -profile test 测试您的设置

首先,准备一个包含输入数据的样本表,其格式如下:

sample,run_accession,instrument_platform,fastq_1,fastq_2,fasta
2612,run1,ILLUMINA,2612_run1_R1.fq.gz,,
2612,run2,ILLUMINA,2612_run2_R1.fq.gz,,
2612,run3,ILLUMINA,2612_run3_R1.fq.gz,2612_run3_R2.fq.gz,

每一行代表一个 fastq 文件(单端)、一对 fastq 文件(双端)或一个 fasta 文件(长读长)。

此外,您还需要一个如下所示的数据库工作表:

tool,db_name,db_params,db_path
kraken2,db2,--quick,/<path>/<to>/kraken2/testdb-kraken2.tar.gz
metaphlan,db1,,/<path>/<to>/metaphlan/metaphlan_database/

这包括包含您希望运行流水线所针对的工具的数据库的目录或 .tar.gz 归档。

现在,您可以使用以下命令运行流水线:

nextflow run nf-core/taxprofiler \
   -profile <docker/singularity/.../institute> \
   --input samplesheet.csv \
   --databases databases.csv \
   --outdir <OUTDIR>  \
   --run_kraken2 --run_metaphlan

[!WARNING] 请通过 CLI 或 Nextflow -params-file 选项提供流水线参数。包括通过 -c Nextflow 选项提供的自定义配置文件,可用于提供任何配置 除了参数;请参阅 docs.

有关更多详细信息和进一步功能,请参阅 usage documentationparameter documentation.

Pipeline output

要查看使用完整规模数据集的示例测试运行结果,请参阅 nf-core 网站流水线页面上的 results 选项卡。 有关输出文件和报告的更多详细信息,请参阅 output documentation.

Credits

nf-core/taxprofiler 最初由 James A. Fellows Yates, Sofia Stamouli, Moritz E. Beber, Lili Andersson-Li 和 nf-core/taxprofiler 团队编写。

Team

我们感谢以下人员对本流水线的开发做出的贡献:

Acknowledgments

我们也感谢来自以下人员的反馈和评论:

特别是

❤️ 也献给 Zandra Fagernäs 提供的标志。

Contributions and Support

如果您希望为此流水线做出贡献,请参阅贡献指南

如需更多信息或帮助,请随时通过 Slack #taxprofiler 频道联系我们(您可以使用此邀请加入)。

引用

如果您在分析中使用了 nf-core/taxprofiler,请使用以下 doi 进行引用:10.1101/2023.10.20.563221

Stamouli, S., Beber, M. E., Normark, T., Christensen II, T. A., Andersson-Li, L., Borry, M., Jamy, M., nf-core community, & Fellows Yates, J. A. (2023). nf-core/taxprofiler: Highly parallelised and flexible pipeline for metagenomic taxonomic classification and profiling. In bioRxiv (p. 2023.10.20.563221). https://doi.org/10.1101/2023.10.20.563221

对于代码的最新版本,请引用 Zenodo doi:10.5281/zenodo.7728364

流水线所用工具的详细参考文献列表可在 CITATIONS.md 文件中找到。

您可以按以下方式引用 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.