diff --git a/.nf-core.yml b/.nf-core.yml index 2be6b896..58f13c48 100644 --- a/.nf-core.yml +++ b/.nf-core.yml @@ -1,10 +1,8 @@ nf_core_version: 3.5.1 repository_type: pipeline template: - author: James A. Fellows Yates, Sofia Stamouli, Moritz E. Beber, Lili Andersson-Li, - and the nf-core/taxprofiler team - description: Taxonomic classification and profiling of shotgun short- and long-read - metagenomic data + author: James A. Fellows Yates, Sofia Stamouli, Moritz E. Beber, Lili Andersson-Li, and the nf-core/taxprofiler team + description: Taxonomic classification and profiling of shotgun short- and long-read metagenomic data force: false is_nfcore: true name: taxprofiler @@ -12,4 +10,4 @@ template: outdir: . skip_features: - igenomes - version: 1.2.5 + version: 1.3.0dev diff --git a/CHANGELOG.md b/CHANGELOG.md index 64c8a21c..86b5e856 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## v1.3.0dev - [unreleased] + +### `Added` + +### `Fixed` + +### `Changed` + +### `Dependencies` + ## v1.2.5 - [2025-11-21] ### `Added` diff --git a/assets/multiqc_config.yml b/assets/multiqc_config.yml index 9856f677..b9a168ba 100644 --- a/assets/multiqc_config.yml +++ b/assets/multiqc_config.yml @@ -1,7 +1,5 @@ report_comment: > - This report has been generated by the nf-core/taxprofiler - analysis pipeline. For information about how to interpret these results, please see the - documentation. + This report has been generated by the nf-core/taxprofiler analysis pipeline. For information about how to interpret these results, please see the documentation. report_section_order: "nf-core-taxprofiler-methods-description": order: -1000 @@ -323,7 +321,7 @@ table_columns_visible: nonpareil_diversity: true porechop: Input reads: false - Start Trimmed: + Start Trimmed: null Start Trimmed Percent: true End Trimmed: false End Trimmed Percent: true @@ -331,7 +329,7 @@ table_columns_visible: Middle Split Percent: true porechop_abi: Input reads: false - Start Trimmed: + Start Trimmed: null Start Trimmed Percent: true End Trimmed: false End Trimmed Percent: true diff --git a/nextflow.config b/nextflow.config index 19461801..04f1c800 100644 --- a/nextflow.config +++ b/nextflow.config @@ -456,7 +456,7 @@ manifest { mainScript = 'main.nf' defaultBranch = 'master' nextflowVersion = '!>=25.04.2' - version = '1.2.5' + version = '1.3.0dev' doi = '10.1101/2023.10.20.563221' } diff --git a/ro-crate-metadata.json b/ro-crate-metadata.json index ea1c7379..6c4e52f0 100644 --- a/ro-crate-metadata.json +++ b/ro-crate-metadata.json @@ -21,8 +21,8 @@ { "@id": "./", "@type": "Dataset", - "creativeWorkStatus": "Stable", - "datePublished": "2025-11-04T13:38:56+00:00", + "creativeWorkStatus": "InProgress", + "datePublished": "2025-11-21T15:22:39+00:00", "description": "

\n \n \n \"nf-core/taxprofiler\"\n \n

\n\n[![Open in GitHub Codespaces](https://img.shields.io/badge/Open_In_GitHub_Codespaces-black?labelColor=grey&logo=github)](https://github.com/codespaces/new/nf-core/taxprofiler)\n[![GitHub Actions CI Status](https://github.com/nf-core/taxprofiler/actions/workflows/nf-test.yml/badge.svg)](https://github.com/nf-core/taxprofiler/actions/workflows/nf-test.yml)\n[![GitHub Actions Linting Status](https://github.com/nf-core/taxprofiler/actions/workflows/linting.yml/badge.svg)](https://github.com/nf-core/taxprofiler/actions/workflows/linting.yml)[![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?labelColor=000000&logo=Amazon%20AWS)](https://nf-co.re/taxprofiler/results)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.7728364-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.7728364)\n[![nf-test](https://img.shields.io/badge/unit_tests-nf--test-337ab7.svg)](https://www.nf-test.com)\n\n[![Nextflow](https://img.shields.io/badge/version-%E2%89%A525.04.2-green?style=flat&logo=nextflow&logoColor=white&color=%230DC09D&link=https%3A%2F%2Fnextflow.io)](https://www.nextflow.io/)\n[![nf-core template version](https://img.shields.io/badge/nf--core_template-3.5.1-green?style=flat&logo=nfcore&logoColor=white&color=%2324B064&link=https%3A%2F%2Fnf-co.re)](https://github.com/nf-core/tools/releases/tag/3.5.1)\n[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)\n[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)\n[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)\n[![Launch on Seqera Platform](https://img.shields.io/badge/Launch%20%F0%9F%9A%80-Seqera%20Platform-%234256e7)](https://cloud.seqera.io/launch?pipeline=https://github.com/nf-core/taxprofiler)\n\n[![Get help on Slack](http://img.shields.io/badge/slack-nf--core%20%23taxprofiler-4A154B?labelColor=000000&logo=slack)](https://nfcore.slack.com/channels/taxprofiler)[![Follow on Bluesky](https://img.shields.io/badge/bluesky-%40nf__core-1185fe?labelColor=000000&logo=bluesky)](https://bsky.app/profile/nf-co.re)[![Follow on Mastodon](https://img.shields.io/badge/mastodon-nf__core-6364ff?labelColor=FFFFFF&logo=mastodon)](https://mstdn.science/@nf_core)[![Watch on YouTube](http://img.shields.io/badge/youtube-nf--core-FF0000?labelColor=000000&logo=youtube)](https://www.youtube.com/c/nf-core)\n\n[![Cite Preprint](https://img.shields.io/badge/Cite%20Us!-Cite%20Preprint-orange)](https://doi.org/10.1101/2023.10.20.563221)\n\n## Introduction\n\n**nf-core/taxprofiler** is a bioinformatics best-practice analysis pipeline for taxonomic classification and profiling of shotgun short- and long-read metagenomic data. It allows for in-parallel taxonomic identification of reads or taxonomic abundance estimation with multiple classification and profiling tools against multiple databases, and produces standardised output tables for facilitating results comparison between different tools and databases.\n\n## Pipeline summary\n\n![](docs/images/taxprofiler_tube.png)\n\n1. Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/) or [`falco`](https://github.com/smithlabcode/falco) as an alternative option)\n2. Performs optional read pre-processing\n - Adapter clipping and merging (short-read: [fastp](https://github.com/OpenGene/fastp), [AdapterRemoval2](https://github.com/MikkelSchubert/adapterremoval); long-read: [porechop](https://github.com/rrwick/Porechop), [Porechop_ABI](https://github.com/bonsai-team/Porechop_ABI))\n - Low complexity and quality filtering (short-read: [bbduk](https://jgi.doe.gov/data-and-tools/software-tools/bbtools/), [PRINSEQ++](https://github.com/Adrian-Cantu/PRINSEQ-plus-plus); long-read: [Filtlong](https://github.com/rrwick/Filtlong)), [Nanoq](https://github.com/esteinig/nanoq)\n - Host-read removal (short-read: [BowTie2](http://bowtie-bio.sourceforge.net/bowtie2/); long-read: [Minimap2](https://github.com/lh3/minimap2))\n - Run merging\n3. Supports statistics metagenome coverage estimation ([Nonpareil](https://nonpareil.readthedocs.io/en/latest/)) and for host-read removal ([Samtools](http://www.htslib.org/))\n4. Performs taxonomic classification and/or profiling using one or more of:\n - [Kraken2](https://ccb.jhu.edu/software/kraken2/)\n - [MetaPhlAn](https://huttenhower.sph.harvard.edu/metaphlan/)\n - [MALT](https://uni-tuebingen.de/fakultaeten/mathematisch-naturwissenschaftliche-fakultaet/fachbereiche/informatik/lehrstuehle/algorithms-in-bioinformatics/software/malt/)\n - [DIAMOND](https://github.com/bbuchfink/diamond)\n - [Centrifuge](https://ccb.jhu.edu/software/centrifuge/)\n - [Kaiju](https://kaiju.binf.ku.dk/)\n - [mOTUs](https://motu-tool.org/)\n - [KrakenUniq](https://github.com/fbreitwieser/krakenuniq)\n - [KMCP](https://github.com/shenwei356/kmcp)\n - [ganon](https://pirovc.github.io/ganon/)\n5. Perform optional post-processing with:\n - [bracken](https://ccb.jhu.edu/software/bracken/)\n6. Standardises output tables ([`Taxpasta`](https://taxpasta.readthedocs.io))\n7. Present QC for raw reads ([`MultiQC`](http://multiqc.info/))\n8. Plotting Kraken2, Centrifuge, Kaiju and MALT results ([`Krona`](https://hpc.nih.gov/apps/kronatools.html))\n\n## Usage\n\n> [!NOTE]\n> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.\n\nFirst, prepare a samplesheet with your input data that looks as follows:\n\n```csv title=\"samplesheet.csv\"\nsample,run_accession,instrument_platform,fastq_1,fastq_2,fasta\n2612,run1,ILLUMINA,2612_run1_R1.fq.gz,,\n2612,run2,ILLUMINA,2612_run2_R1.fq.gz,,\n2612,run3,ILLUMINA,2612_run3_R1.fq.gz,2612_run3_R2.fq.gz,\n```\n\nEach row represents a fastq file (single-end), a pair of fastq files (paired end), or a fasta (with long reads).\n\nAdditionally, you will need a database sheet that looks as follows:\n\n```csv title=\"databases.csv\"\ntool,db_name,db_params,db_path\nkraken2,db2,--quick,///kraken2/testdb-kraken2.tar.gz\nmetaphlan,db1,,///metaphlan/metaphlan_database/\n```\n\nThat includes directories or `.tar.gz` archives containing databases for the tools you wish to run the pipeline against.\n\nNow, you can run the pipeline using:\n\n```bash\nnextflow run nf-core/taxprofiler \\\n -profile \\\n --input samplesheet.csv \\\n --databases databases.csv \\\n --outdir \\\n --run_kraken2 --run_metaphlan\n```\n\n> [!WARNING]\n> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_; see [docs](https://nf-co.re/docs/usage/getting_started/configuration#custom-configuration-files).\n\nFor more details and further functionality, please refer to the [usage documentation](https://nf-co.re/taxprofiler/usage) and the [parameter documentation](https://nf-co.re/taxprofiler/parameters).\n\n## Pipeline output\n\nTo see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/taxprofiler/results) tab on the nf-core website pipeline page.\nFor more details about the output files and reports, please refer to the\n[output documentation](https://nf-co.re/taxprofiler/output).\n\n## Credits\n\nnf-core/taxprofiler was originally written by James A. Fellows Yates, Sofia Stamouli, Moritz E. Beber, Lili Andersson-Li, and the nf-core/taxprofiler team.\n\n### Team\n\n- [James A. Fellows Yates](https://github.com/jfy133)\n- [Sofia Stamouli](https://github.com/sofstam)\n- [Moritz E. Beber](https://github.com/Midnighter)\n- [Lili Andersson-Li](https://github.com/LilyAnderssonLee)\n\nWe thank the following people for their contributions to the development of this pipeline:\n\n- [Lauri Mesilaakso](https://github.com/ljmesi)\n- [Tanja Normark](https://github.com/talnor)\n- [Maxime Borry](https://github.com/maxibor)\n- [Thomas A. Christensen II](https://github.com/MillironX)\n- [Jianhong Ou](https://github.com/jianhong)\n- [Rafal Stepien](https://github.com/rafalstepien)\n- [Mahwash Jamy](https://github.com/mjamy)\n- [Alex Caswell](https://github.com/AlexHoratio)\n- [Aidan Epstein](https://github.com/epstein6)\n\n### Acknowledgments\n\nWe also are grateful for the feedback and comments from:\n\n- The general [nf-core/community](https://nf-co.re/community)\n\nAnd specifically to\n\n- [Alex H\u00fcbner](https://github.com/alexhbnr)\n\n\u2764\ufe0f also goes to [Zandra Fagern\u00e4s](https://github.com/ZandraFagernas) for the logo.\n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\nFor further information or help, don't hesitate to get in touch on the [Slack `#taxprofiler` channel](https://nfcore.slack.com/channels/taxprofiler) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\nIf you use nf-core/taxprofiler for your analysis, please cite it using the following doi: [10.1101/2023.10.20.563221](https://doi.org/10.1101/2023.10.20.563221).\n\n> 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\n\nFor the latest version of the code, cite the Zenodo doi: [10.5281/zenodo.7728364](https://doi.org/10.5281/zenodo.7728364)\n\nAn extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.\n\nYou can cite the `nf-core` publication as follows:\n\n> **The nf-core framework for community-curated bioinformatics pipelines.**\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n", "hasPart": [ { @@ -102,7 +102,7 @@ }, "mentions": [ { - "@id": "#2461b742-76fd-4444-ab5b-9b3aeb90c191" + "@id": "#ea375ca3-7bb8-4685-9df9-4a26a2000a47" } ], "name": "nf-core/taxprofiler" @@ -131,7 +131,7 @@ ], "creator": [ { - "@id": "#jfy133@gmail.com" + "@id": "#64467552+LilyAnderssonLee@users.noreply.github.com" }, { "@id": "https://orcid.org/0009-0006-0893-3771" @@ -140,11 +140,11 @@ "@id": "#jfy133@gmail.com" }, { - "@id": "#64467552+LilyAnderssonLee@users.noreply.github.com" + "@id": "#jfy133@gmail.com" } ], "dateCreated": "", - "dateModified": "2025-11-20T09:32:24Z", + "dateModified": "2025-11-21T16:22:39Z", "dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/", "keywords": [ "nf-core", @@ -166,13 +166,13 @@ ], "maintainer": [ { - "@id": "https://orcid.org/0009-0006-0893-3771" + "@id": "#64467552+LilyAnderssonLee@users.noreply.github.com" }, { - "@id": "#jfy133@gmail.com" + "@id": "https://orcid.org/0009-0006-0893-3771" }, { - "@id": "#64467552+LilyAnderssonLee@users.noreply.github.com" + "@id": "#jfy133@gmail.com" } ], "name": [ @@ -186,10 +186,10 @@ }, "url": [ "https://github.com/nf-core/taxprofiler", - "https://nf-co.re/taxprofiler/1.2.5/" + "https://nf-co.re/taxprofiler/dev/" ], "version": [ - "1.2.5" + "1.3.0dev" ] }, { @@ -205,11 +205,11 @@ "version": "!>=25.04.2" }, { - "@id": "#2461b742-76fd-4444-ab5b-9b3aeb90c191", + "@id": "#ea375ca3-7bb8-4685-9df9-4a26a2000a47", "@type": "TestSuite", "instance": [ { - "@id": "#4283fc55-1da2-4c26-87d8-83e49203a55a" + "@id": "#8758485a-f8a7-4949-b7e8-281b3b251cc9" } ], "mainEntity": { @@ -218,7 +218,7 @@ "name": "Test suite for nf-core/taxprofiler" }, { - "@id": "#4283fc55-1da2-4c26-87d8-83e49203a55a", + "@id": "#8758485a-f8a7-4949-b7e8-281b3b251cc9", "@type": "TestInstance", "name": "GitHub Actions workflow for testing nf-core/taxprofiler", "resource": "repos/nf-core/taxprofiler/actions/workflows/nf-test.yml", @@ -352,22 +352,22 @@ "url": "https://nf-co.re/" }, { - "@id": "#jfy133@gmail.com", + "@id": "#64467552+LilyAnderssonLee@users.noreply.github.com", "@type": "Person", - "email": "jfy133@gmail.com", - "name": "James A. Fellows Yates" + "email": "64467552+LilyAnderssonLee@users.noreply.github.com", + "name": "Lili Andersson-Li" }, { "@id": "https://orcid.org/0009-0006-0893-3771", "@type": "Person", - "email": "91951607+sofstam@users.noreply.github.com", + "email": "sstamo@login1.hsn.dardel.pdc.kth.se", "name": "Sofia Stamouli" }, { - "@id": "#64467552+LilyAnderssonLee@users.noreply.github.com", + "@id": "#jfy133@gmail.com", "@type": "Person", - "email": "64467552+LilyAnderssonLee@users.noreply.github.com", - "name": "Lili Andersson-Li" + "email": "jfy133@gmail.com", + "name": "James Fellows Yates" } ] } \ No newline at end of file diff --git a/tests/default.nf.test.snap b/tests/default.nf.test.snap index 747b4085..15471c96 100644 --- a/tests/default.nf.test.snap +++ b/tests/default.nf.test.snap @@ -136,7 +136,7 @@ "untar": 1.34 }, "Workflow": { - "nf-core/taxprofiler": "v1.2.5" + "nf-core/taxprofiler": "v1.3.0dev" } } ],