-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #766 from nf-core/post-3.3.1-versionbump
Post-release version bump
- Loading branch information
Showing
5 changed files
with
49 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,4 +16,4 @@ template: | |
| name: mag | ||
| org: nf-core | ||
| outdir: . | ||
| version: 3.3.1 | ||
| version: 3.3.2dev | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,8 +21,8 @@ | |
| { | ||
| "@id": "./", | ||
| "@type": "Dataset", | ||
| "creativeWorkStatus": "Stable", | ||
| "datePublished": "2025-02-10T08:00:01+00:00", | ||
| "creativeWorkStatus": "InProgress", | ||
| "datePublished": "2025-02-13T13:09:42+00:00", | ||
| "description": "<h1>\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"docs/images/mag_logo_mascot_dark.png\">\n <img alt=\"nf-core/mag\" src=\"docs/images/mag_logo_mascot_light.png\">\n </picture>\n</h1>\n\n[](https://github.com/nf-core/mag/actions/workflows/ci.yml)\n[](https://github.com/nf-core/mag/actions/workflows/linting.yml)[](https://nf-co.re/mag/results)[](https://doi.org/10.5281/zenodo.3589527)\n[](https://www.nf-test.com)\n[](https://doi.org/10.1093/nargab/lqac007)\n\n[](https://www.nextflow.io/)\n[](https://docs.conda.io/en/latest/)\n[](https://www.docker.com/)\n[](https://sylabs.io/docs/)\n[](https://cloud.seqera.io/launch?pipeline=https://github.com/nf-core/mag)\n\n[](https://nfcore.slack.com/channels/mag)[](https://twitter.com/nf_core)[](https://mstdn.science/@nf_core)[](https://www.youtube.com/c/nf-core)\n\n## Introduction\n\n**nf-core/mag** is a bioinformatics best-practise analysis pipeline for assembly, binning and annotation of metagenomes.\n\n<p align=\"center\">\n <img src=\"docs/images/mag_workflow.png\" alt=\"nf-core/mag workflow overview\" width=\"90%\">\n</p>\n\n## Pipeline summary\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\nBy default, the pipeline currently performs the following: it supports both short and long reads, quality trims the reads and adapters with [fastp](https://github.com/OpenGene/fastp) and [Porechop](https://github.com/rrwick/Porechop), and performs basic QC with [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/), and merge multiple sequencing runs.\n\nThe pipeline then:\n\n- assigns taxonomy to reads using [Centrifuge](https://ccb.jhu.edu/software/centrifuge/) and/or [Kraken2](https://github.com/DerrickWood/kraken2/wiki)\n- performs assembly using [MEGAHIT](https://github.com/voutcn/megahit) and [SPAdes](http://cab.spbu.ru/software/spades/), and checks their quality using [Quast](http://quast.sourceforge.net/quast)\n- (optionally) performs ancient DNA assembly validation using [PyDamage](https://github.com/maxibor/pydamage) and contig consensus sequence recalling with [Freebayes](https://github.com/freebayes/freebayes) and [BCFtools](http://samtools.github.io/bcftools/bcftools.html)\n- predicts protein-coding genes for the assemblies using [Prodigal](https://github.com/hyattpd/Prodigal), and bins with [Prokka](https://github.com/tseemann/prokka) and optionally [MetaEuk](https://www.google.com/search?channel=fs&client=ubuntu-sn&q=MetaEuk)\n- performs metagenome binning using [MetaBAT2](https://bitbucket.org/berkeleylab/metabat/src/master/), [MaxBin2](https://sourceforge.net/projects/maxbin2/), and/or with [CONCOCT](https://github.com/BinPro/CONCOCT), and checks the quality of the genome bins using [Busco](https://busco.ezlab.org/), [CheckM](https://ecogenomics.github.io/CheckM/), or [CheckM2](https://github.com/chklovski/CheckM2) and optionally [GUNC](https://grp-bork.embl-community.io/gunc/).\n- Performs ancient DNA validation and repair with [pyDamage](https://github.com/maxibor/pydamage) and [freebayes](https://github.com/freebayes/freebayes)\n- optionally refines bins with [DAS Tool](https://github.com/cmks/DAS_Tool)\n- assigns taxonomy to bins using [GTDB-Tk](https://github.com/Ecogenomics/GTDBTk) and/or [CAT](https://github.com/dutilh/CAT) and optionally identifies viruses in assemblies using [geNomad](https://github.com/apcamargo/genomad), or Eukaryotes with [Tiara](https://github.com/ibe-uw/tiara)\n\nFurthermore, the pipeline creates various reports in the results directory specified, including a [MultiQC](https://multiqc.info/) report summarizing some of the findings and software versions.\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\n```bash\nnextflow run nf-core/mag -profile <docker/singularity/podman/shifter/charliecloud/conda/institute> --input '*_R{1,2}.fastq.gz' --outdir <OUTDIR>\n```\n\nor\n\n```bash\nnextflow run nf-core/mag -profile <docker/singularity/podman/shifter/charliecloud/conda/institute> --input samplesheet.csv --outdir <OUTDIR>\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/mag/usage) and the [parameter documentation](https://nf-co.re/mag/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/mag/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/mag/output).\n\n### Group-wise co-assembly and co-abundance computation\n\nEach sample has an associated group ID (see [input specifications](https://nf-co.re/mag/usage#input_specifications)). This group information can be used for group-wise co-assembly with `MEGAHIT` or `SPAdes` and/or to compute co-abundances for the binning step with `MetaBAT2`. By default, group-wise co-assembly is disabled, while the computation of group-wise co-abundances is enabled. For more information about how this group information can be used see the documentation for the parameters [`--coassemble_group`](https://nf-co.re/mag/parameters#coassemble_group) and [`--binning_map_mode`](https://nf-co.re/mag/parameters#binning_map_mode).\n\nWhen group-wise co-assembly is enabled, `SPAdes` is run on accordingly pooled read files, since `metaSPAdes` does not yet allow the input of multiple samples or libraries. In contrast, `MEGAHIT` is run for each group while supplying lists of the individual readfiles.\n\n## Credits\n\nnf-core/mag was written by [Hadrien Gourl\u00e9](https://hadriengourle.com) at [SLU](https://slu.se), [Daniel Straub](https://github.com/d4straub) and [Sabrina Krakau](https://github.com/skrakau) at the [Quantitative Biology Center (QBiC)](http://qbic.life). [James A. Fellows Yates](https://github.com/jfy133) and [Maxime Borry](https://github.com/maxibor) at the [Max Planck Institute for Evolutionary Anthropology](https://www.eva.mpg.de) joined in version 2.2.0.\n\nOther code contributors include:\n\n- [Antonia Schuster](https://github.com/AntoniaSchuster)\n- [Alexander Ramos](https://github.com/alxndrdiaz)\n- [Carson Miller](https://github.com/CarsonJM)\n- [Daniel Lundin](https://github.com/erikrikarddaniel)\n- [Danielle Callan](https://github.com/d-callan)\n- [Gregory Sprenger](https://github.com/gregorysprenger)\n- [Jim Downie](https://github.com/prototaxites)\n- [Phil Palmer](https://github.com/PhilPalmer)\n- [@willros](https://github.com/willros)\n- [Adam Rosenbaum](https://github.com/muabnezor)\n- [Diego Alvarez](https://github.com/dialvarezs)\n\nLong read processing was inspired by [caspargross/HybridAssembly](https://github.com/caspargross/HybridAssembly) written by Caspar Gross [@caspargross](https://github.com/caspargross)\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n- [Alexander Peltzer](https://github.com/apeltzer)\n- [Phil Ewels](https://github.com/ewels)\n- [Gisela Gabernet](https://github.com/ggabernet)\n- [Harshil Patel](https://github.com/drpatelh)\n- [Johannes Alneberg](https://github.com/alneberg)\n- [Maxime Garcia](https://github.com/MaxUlysse)\n- [Michael L Heuer](https://github.com/heuermh)\n- [Alex H\u00fcbner](https://github.com/alexhbnr)\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 `#mag` channel](https://nfcore.slack.com/channels/mag) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\nIf you use nf-core/mag for your analysis, please cite the preprint as follows:\n\n> **nf-core/mag: a best-practice pipeline for metagenome hybrid assembly and binning**\n>\n> Sabrina Krakau, Daniel Straub, Hadrien Gourl\u00e9, Gisela Gabernet, Sven Nahnsen.\n>\n> NAR Genom Bioinform. 2022 Feb 2;4(1):lqac007. doi: [10.1093/nargab/lqac007](https://doi.org/10.1093/nargab/lqac007).\n\nAdditionally you can cite the pipeline directly with the following doi: [10.5281/zenodo.3589527](https://doi.org/10.5281/zenodo.3589527)\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": [ | ||
| { | ||
|
|
@@ -105,7 +105,7 @@ | |
| }, | ||
| "mentions": [ | ||
| { | ||
| "@id": "#a0650a39-dd17-40a6-b52c-f4f7cb6db901" | ||
| "@id": "#5b7c2972-415a-42e2-90d4-51d253423d9f" | ||
| } | ||
| ], | ||
| "name": "nf-core/mag" | ||
|
|
@@ -134,26 +134,26 @@ | |
| ], | ||
| "creator": [ | ||
| { | ||
| "@id": "https://orcid.org/0000-0003-0603-7907" | ||
| "@id": "#[email protected]" | ||
| }, | ||
| { | ||
| "@id": "#[email protected]" | ||
| "@id": "https://orcid.org/0000-0001-9807-1082" | ||
| }, | ||
| { | ||
| "@id": "#[email protected]" | ||
| "@id": "https://orcid.org/0000-0003-0603-7907" | ||
| }, | ||
| { | ||
| "@id": "#jfy133@gmail.com" | ||
| "@id": "#[email protected].com" | ||
| }, | ||
| { | ||
| "@id": "https://orcid.org/0000-0001-9807-1082" | ||
| "@id": "#[email protected]" | ||
| }, | ||
| { | ||
| "@id": "#[email protected].com" | ||
| "@id": "#jfy133@gmail.com" | ||
| } | ||
| ], | ||
| "dateCreated": "", | ||
| "dateModified": "2025-02-10T09:00:01Z", | ||
| "dateModified": "2025-02-13T14:09:42Z", | ||
| "dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/", | ||
| "keywords": [ | ||
| "nf-core", | ||
|
|
@@ -171,6 +171,9 @@ | |
| "MIT" | ||
| ], | ||
| "maintainer": [ | ||
| { | ||
| "@id": "https://orcid.org/0000-0001-9807-1082" | ||
| }, | ||
| { | ||
| "@id": "https://orcid.org/0000-0003-0603-7907" | ||
| }, | ||
|
|
@@ -179,9 +182,6 @@ | |
| }, | ||
| { | ||
| "@id": "#[email protected]" | ||
| }, | ||
| { | ||
| "@id": "https://orcid.org/0000-0001-9807-1082" | ||
| } | ||
| ], | ||
| "name": [ | ||
|
|
@@ -195,10 +195,10 @@ | |
| }, | ||
| "url": [ | ||
| "https://github.com/nf-core/mag", | ||
| "https://nf-co.re/mag/3.3.1/" | ||
| "https://nf-co.re/mag/dev/" | ||
| ], | ||
| "version": [ | ||
| "3.3.1" | ||
| "3.3.2dev" | ||
| ] | ||
| }, | ||
| { | ||
|
|
@@ -214,11 +214,11 @@ | |
| "version": "!>=24.04.2" | ||
| }, | ||
| { | ||
| "@id": "#a0650a39-dd17-40a6-b52c-f4f7cb6db901", | ||
| "@id": "#5b7c2972-415a-42e2-90d4-51d253423d9f", | ||
| "@type": "TestSuite", | ||
| "instance": [ | ||
| { | ||
| "@id": "#afdb65e2-7cdb-44a8-859e-15d6c00245c0" | ||
| "@id": "#589b7434-ee6c-4bc0-a043-5d0fdb4d7c51" | ||
| } | ||
| ], | ||
| "mainEntity": { | ||
|
|
@@ -227,7 +227,7 @@ | |
| "name": "Test suite for nf-core/mag" | ||
| }, | ||
| { | ||
| "@id": "#afdb65e2-7cdb-44a8-859e-15d6c00245c0", | ||
| "@id": "#589b7434-ee6c-4bc0-a043-5d0fdb4d7c51", | ||
| "@type": "TestInstance", | ||
| "name": "GitHub Actions workflow for testing nf-core/mag", | ||
| "resource": "repos/nf-core/mag/actions/workflows/ci.yml", | ||
|
|
@@ -366,34 +366,34 @@ | |
| "url": "https://nf-co.re/" | ||
| }, | ||
| { | ||
| "@id": "https://orcid.org/0000-0003-0603-7907", | ||
| "@id": "#[email protected]", | ||
| "@type": "Person", | ||
| "email": "sabrina.krakau.qbic@gmail.com", | ||
| "name": "Sabrina Krakau" | ||
| "email": "[email protected].com", | ||
| "name": "Carson J Miller" | ||
| }, | ||
| { | ||
| "@id": "#[email protected]", | ||
| "@id": "https://orcid.org/0000-0001-9807-1082", | ||
| "@type": "Person", | ||
| "email": "jfy133@gmail.com", | ||
| "name": "James A. Fellows Yates" | ||
| "email": "gourlehadrien@gmail.com", | ||
| "name": "Hadrien Gourl\u00e9" | ||
| }, | ||
| { | ||
| "@id": "#[email protected]", | ||
| "@id": "https://orcid.org/0000-0003-0603-7907", | ||
| "@type": "Person", | ||
| "email": "[email protected].com", | ||
| "name": "Daniel Straub" | ||
| "email": "sabrina.krakau.qbic@gmail.com", | ||
| "name": "Sabrina Krakau" | ||
| }, | ||
| { | ||
| "@id": "https://orcid.org/0000-0001-9807-1082", | ||
| "@id": "#[email protected]", | ||
| "@type": "Person", | ||
| "email": "gourlehadrien@gmail.com", | ||
| "name": "Hadrien Gourl\u00e9" | ||
| "email": "[email protected].com", | ||
| "name": "Daniel Straub" | ||
| }, | ||
| { | ||
| "@id": "#[email protected].com", | ||
| "@id": "#jfy133@gmail.com", | ||
| "@type": "Person", | ||
| "email": "[email protected].com", | ||
| "name": "Carson J Miller" | ||
| "email": "jfy133@gmail.com", | ||
| "name": "James Fellows Yates" | ||
| } | ||
| ] | ||
| } | ||