Skip to content

Commit 99859fc

Browse files
authored
Merge pull request #914 from nf-core/dev
Release: v5.2.0 Puce Pangolin
2 parents b0bc5ca + b04a935 commit 99859fc

62 files changed

Lines changed: 1235 additions & 510 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/nf-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
runs-on: # use self-hosted runners
6565
- runs-on=${{ github.run_id }}-nf-test
6666
- runner=4cpu-linux-x64
67-
- disk=large
67+
- volume=80gb
6868
strategy:
6969
fail-fast: false
7070
matrix:

.github/workflows/release-announcements.yml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ jobs:
1717
- name: get description
1818
id: get_description
1919
run: |
20-
echo "description=$(curl -s https://nf-co.re/pipelines.json | jq -r '.remote_workflows[] | select(.full_name == "${{ github.repository }}") | .description' >> $GITHUB_OUTPUT
21-
20+
echo "description=$(curl -s https://nf-co.re/pipelines.json | jq -r '.remote_workflows[] | select(.full_name == "${{ github.repository }}") | .description')" >> $GITHUB_OUTPUT
2221
- uses: rzr/fediverse-action@master
2322
with:
2423
access-token: ${{ secrets.MASTODON_ACCESS_TOKEN }}
@@ -27,9 +26,7 @@ jobs:
2726
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
2827
message: |
2928
Pipeline release! ${{ github.repository }} v${{ github.event.release.tag_name }} - ${{ github.event.release.name }}!
30-
31-
${{ steps.get_topics.outputs.description }}
32-
29+
${{ steps.get_description.outputs.description }}
3330
Please see the changelog: ${{ github.event.release.html_url }}
3431
3532
${{ steps.get_topics.outputs.topics }} #nfcore #openscience #nextflow #bioinformatics

.nf-core.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ template:
1616
name: mag
1717
org: nf-core
1818
outdir: .
19-
version: 5.1.0
19+
version: 5.2.0

CHANGELOG.md

Lines changed: 60 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,38 @@
33
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
44
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
55

6-
## v5.1.0 - 2025-10-27
6+
## v5.2.0 - Puce Pangolin [2025-11-07]
7+
8+
### `Added`
9+
10+
- [#842](https://github.com/nf-core/mag/pull/842) - Add support for running multiple binQC tools in one run using dedicated `--run_busco`, `--run_checkm`, and `--run_checkm2` parameters (by @harper357, with contributions from @dialvarezs, @prototaxites and @jfy133)
11+
- [#881](https://github.com/nf-core/mag/pull/881) - Add binner MetaBinner (by @d4straub, insprired by @HeshamAlmessady & @AlphaSquad)
12+
13+
### `Changed`
14+
15+
- [#842](https://github.com/nf-core/mag/pull/842) - Change `bin_summary.tsv` format for improved clarity and more comprehensiveness (by @harper357, with contributions from @dialvarezs, @prototaxites and @jfy133)
16+
- Now will include columns from all bin QC tools executed in a given run (i.e., all/any of BUSCO, CheckM and CheckM2)
17+
- Adds suffixes to all columns (`_<toolname>`) to distinguish which column comes from which tool
18+
19+
### `Fixed`
20+
21+
- [#896](https://github.com/nf-core/mag/pull/896) - Remove obsolete execution command from README (by @dialvarezs)
22+
- [#907](https://github.com/nf-core/mag/pull/907) - Include refined bins from all binners in the `DASTool/bins` output folder (by @AlexHoratio)
23+
- [#911](https://github.com/nf-core/mag/pull/911) - Ensure column order is consistent when generating depth summaries to prevent swapped results on merged depth summary (by @dialvarezs)
24+
- [#912](https://github.com/nf-core/mag/pull/912) - Fix validation of multiple sequencing platforms when using `binning_map_mode = "all"` (reported by @mjfi2sb3, fix by @dialvarezs)
25+
- [#921](https://github.com/nf-core/mag/pull/921) - Fix publishing of BUSCO files (reported by @joao1980, fix by @dialvarezs)
26+
27+
### `Dependencies`
28+
29+
| Tool | Previous version | New version |
30+
| ---------- | ---------------- | ----------- |
31+
| MetaBinner | | 1.4.4-0 |
32+
33+
### `Deprecated`
34+
35+
- [#842](https://github.com/nf-core/mag/pull/842) - Remove `--binqc_tool` (by @harper357, with contributions from @dialvarezs, @prototaxites and @jfy133)
36+
37+
## v5.1.0 - Platinum Pudu [2025-10-27]
738

839
### `Added`
940

@@ -30,7 +61,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3061

3162
### `Deprecated`
3263

33-
## 5.0.0 - [2025-09-30]
64+
## v5.0.0 - Green Squirrel [2025-09-30]
3465

3566
### `Added`
3667

@@ -102,7 +133,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
102133
- [#855](https://github.com/nf-core/mag/pull/855) - Remove test_adapterremoval, test_ancient_dna, test_bbnorm, test_busco_auto, test_host_rm, test_hybrid_host_rm, test_binrefinement, test_concoct and test_longread profiles (added by @dialvarezs)
103134
- [#864](https://github.com/nf-core/mag/pull/864) - Remove `--gtdb_mash` due to dropping of support by GTDBTk itself (by @prototaxites and @jfy133)
104135

105-
## v4.0.0 - [2025-05-22]
136+
## v4.0.0 - Blue Huemul [2025-05-22]
106137

107138
### `Added`
108139

@@ -138,7 +169,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
138169

139170
- [#730](https://github.com/nf-core/mag/pull/730) - Remove `--busco_auto_lineage_prok` due to update and simplified usage of BUSCO (added by @jfy133, @dialvarezs)
140171

141-
## 3.4.0 [2025-04-04]
172+
## v3.4.0 - Green Gecko [2025-04-04]
142173

143174
### `Added`
144175

@@ -187,7 +218,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
187218

188219
### `Deprecated`
189220

190-
## 3.3.0 [2024-12-19]
221+
## v3.3.0 - Red Reindeer [2024-12-19]
191222

192223
### `Added`
193224

@@ -222,7 +253,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
222253

223254
### `Deprecated`
224255

225-
## 3.2.1 [2024-10-30]
256+
## v3.2.1 [2024-10-30]
226257

227258
### `Added`
228259

@@ -236,7 +267,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
236267

237268
### `Deprecated`
238269

239-
## 3.2.0 [2024-10-27]
270+
## v3.2.0 - Salmon Salmon [2024-10-27]
240271

241272
### `Added`
242273

@@ -268,7 +299,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
268299

269300
### `Deprecated`
270301

271-
## 3.1.0 [2024-10-04]
302+
## v3.1.0 - Pink Panda [2024-10-04]
272303

273304
### `Added`
274305

@@ -296,7 +327,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
296327

297328
- [#670](https://github.com/nf-core/mag/pull/670) - Deprecated `--gtdbtk_pplacer_scratch` due to unintuitive usage (reported by harper357, fixed by @jfy133)
298329

299-
## 3.0.3 [2024-08-27]
330+
## v3.0.3 [2024-08-27]
300331

301332
### `Added`
302333

@@ -315,7 +346,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
315346

316347
### `Deprecated`
317348

318-
## 3.0.2 [2024-07-04]
349+
## v3.0.2 [2024-07-04]
319350

320351
### `Added`
321352

@@ -338,7 +369,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
338369

339370
### `Deprecated`
340371

341-
## 3.0.1 [2024-06-10]
372+
## v3.0.1 [2024-06-10]
342373

343374
### `Added`
344375

@@ -358,7 +389,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
358389

359390
### `Deprecated`
360391

361-
## 3.0.0 - [2024-05-13]
392+
## v3.0.0 - Magenta Magpie [2024-05-13]
362393

363394
### `Added`
364395

@@ -379,7 +410,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
379410

380411
- [#599](https://github.com/nf-core/mag/pull/599) - Direct reads input (`--input 'sample_{R1,R2}.fastq.gz'`) is no longer supported, all input must come via samplesheets (by @jfy133)
381412

382-
## 2.5.4 - [2024-02-12]
413+
## v2.5.4 [2024-02-12]
383414

384415
### `Added`
385416

@@ -396,7 +427,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
396427

397428
### `Deprecated`
398429

399-
## 2.5.3 - [2024-02-05]
430+
## v2.5.3 [2024-02-05]
400431

401432
### `Added`
402433

@@ -412,7 +443,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
412443

413444
### `Deprecated`
414445

415-
## 2.5.2 - [2024-02-02]
446+
## v2.5.2 [2024-02-02]
416447

417448
### `Added`
418449

@@ -437,7 +468,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
437468

438469
### `Deprecated`
439470

440-
## 2.5.1 - [2023-11-17]
471+
## v2.5.1 [2023-11-17]
441472

442473
### `Added`
443474

@@ -459,7 +490,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
459490

460491
- [#536](https://github.com/nf-core/mag/pull/536) - Remove custom function with native Nextflow for checking file extension (reported by @d4straub, fix by @jfy133)
461492

462-
## 2.5.0 - [2023-10-10]
493+
## 2.5.0 - Aquamarine Kangaroo - [2023-10-10]
463494

464495
### `Added`
465496

@@ -484,7 +515,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
484515

485516
- [#504](https://github.com/nf-core/mag/pull/504) - `--busco_reference`, `--busco_download_path`, `--save_busco_reference` parameters have been deprecated and replaced with new parameters (by @gregorysprenger).
486517

487-
## 2.4.0 - 2023-09-26
518+
## v2.4.0 - Grey Hammerhead [2023-09-26]
488519

489520
### `Added`
490521

@@ -548,7 +579,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
548579
- [#458](https://github.com/nf-core/mag/pull/458) - Correct the major issue in ancient DNA workflow of binning refinement being performed on uncorrected contigs instead of aDNA consensus recalled contigs (issue [#449](https://github.com/nf-core/mag/issues/449))
549580
- [#451](https://github.com/nf-core/mag/pull/451) - Fix results file overwriting in Ancient DNA workflow (reported by @alexhbnr, fix by @jfy133, and integrated by @maxibor in [#458](https://github.com/nf-core/mag/pull/458) )
550581

551-
## v2.3.0 - [2023/03/02]
582+
## v2.3.0 - Red Cow [2023-03-02]
552583

553584
### `Added`
554585

@@ -585,7 +616,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
585616
| Freebayes | 1.3.5 | 1.3.6 |
586617
| SAMtools | 1.15 | 1.16.1 |
587618

588-
## v2.2.1 - 2022/08/25
619+
## v2.2.1 [2022-08-25]
589620

590621
### `Added`
591622

@@ -598,7 +629,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
598629

599630
### `Dependencies`
600631

601-
## v2.2.0 - 2022/06/14
632+
## v2.2.0 - Golden Mammoth [2022-06-14]
602633

603634
### `Added`
604635

@@ -631,7 +662,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
631662
| fastp | 0.20.1 | 0.23.2 |
632663
| MultiQC | 1.11 | 1.12 |
633664

634-
## v2.1.1 - 2021/11/25
665+
## v2.1.1 [2021-11-25]
635666

636667
### `Added`
637668

@@ -654,7 +685,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
654685
- [#255](https://github.com/nf-core/mag/pull/255) - Update gtdbtk conda channel.
655686
- [#258](https://github.com/nf-core/mag/pull/258) - FastP results are now in MultiQC.
656687

657-
## v2.1.0 - 2021/07/29
688+
## v2.1.0 - Black Zebra [2021-07-29]
658689

659690
### `Added`
660691

@@ -670,7 +701,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
670701

671702
- [#226](https://github.com/nf-core/mag/pull/226) - Fix handling of `BUSCO` output when run in auto lineage selection mode and selected specific lineage is the same as the generic one.
672703

673-
## v2.0.0 - 2021/06/01
704+
## v2.0.0 - Silver Swan [2021-06-01]
674705

675706
### `Added`
676707

@@ -705,7 +736,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
705736
- [#195](https://github.com/nf-core/mag/pull/195) - Fix documentation regarding required compression of input FastQ files [#160](https://github.com/nf-core/mag/issues/160)
706737
- [#196](https://github.com/nf-core/mag/pull/196) - Add process for CAT database creation as solution for problem caused by incompatible `DIAMOND` version used for pre-built `CAT database` and `CAT classification` [#90](https://github.com/nf-core/mag/issues/90), [#188](https://github.com/nf-core/mag/issues/188)
707738

708-
## v1.2.0 - 2021/02/10
739+
## v1.2.0 - Yellow Squirrel [2021-02-10]
709740

710741
### `Added`
711742

@@ -725,7 +756,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
725756

726757
- [#143](https://github.com/nf-core/mag/pull/143) - Change parameter: `--manifest` -> `--input`
727758

728-
## v1.1.2 - 2020/11/24
759+
## v1.1.2 - Blue Panda [2020-11-24]
729760

730761
### `Changed`
731762

@@ -735,7 +766,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
735766

736767
- [#133](https://github.com/nf-core/mag/pull/133) - Fixed processing of `--input` parameter [#131](https://github.com/nf-core/mag/issues/131)
737768

738-
## v1.1.1 - 2020/11/10
769+
## v1.1.1 - Lime Owl [2020-11-10]
739770

740771
### `Added`
741772

@@ -752,7 +783,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
752783
- [#120](https://github.com/nf-core/mag/pull/120) - Fix link to CAT database in help message
753784
- [#124](https://github.com/nf-core/mag/pull/124) - Fix description of `CAT` process in `output.md`
754785

755-
## v1.1.0 - 2020/10/06
786+
## v1.1.0 - White Elephant [2020-10-06]
756787

757788
### `Added`
758789

@@ -797,7 +828,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
797828

798829
- [#29](https://github.com/nf-core/mag/pull/29) - Change depreciated parameters: `--singleEnd` -> `--single_end`, `--igenomesIgnore` -> `--igenomes_ignore`
799830

800-
## v1.0.0 - 2019/12/20
831+
## v1.0.0 - Purple Corgi [2019-12-20]
801832

802833
Initial release of nf-core/mag, created with the [nf-core](http://nf-co.re/) template.
803834

CITATIONS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@
5252

5353
> Alneberg, J., Bjarnason, B. S., de Bruijn, I., Schirmer, M., Quick, J., Ijaz, U. Z., Lahti, L., Loman, N. J., Andersson, A. F., & Quince, C. (2014). Binning metagenomic contigs by coverage and composition. Nature Methods, 11(11), 1144–1146. doi: 10.1038/nmeth.3103
5454
55+
- [MetaBinner](https://doi.org/10.1186/s13059-022-02832-6)
56+
57+
> Wang Z, Huang P, You R, Sun F, Zhu S. MetaBinner: a high-performance and stand-alone ensemble binning method to recover individual genomes from complex microbial communities. Genome Biol. 2023 Jan 6;24(1):1. doi: 10.1186/s13059-022-02832-6. PMID: 36609515; PMCID: PMC9817263.
58+
5559
- [DAS Tool](https://doi.org/10.1038/s41564-018-0171-1)
5660

5761
> Sieber, C. M. K., et al. 2018. "Recovery of Genomes from Metagenomes via a Dereplication, Aggregation and Scoring Strategy." Nature Microbiology 3 (7): 836-43. doi: 10.1038/s41564-018-0171-1

README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The pipeline then:
4747
- 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)
4848
- (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)
4949
- 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)
50-
- performs metagenome binning using [MetaBAT2](https://bitbucket.org/berkeleylab/metabat/src/master/), [MaxBin2](https://sourceforge.net/projects/maxbin2/), [CONCOCT](https://github.com/BinPro/CONCOCT), and/or [COMEBin](https://github.com/ziyewang/COMEBin)
50+
- performs metagenome binning using [MetaBAT2](https://bitbucket.org/berkeleylab/metabat/src/master/), [MaxBin2](https://sourceforge.net/projects/maxbin2/), [CONCOCT](https://github.com/BinPro/CONCOCT), [COMEBin](https://github.com/ziyewang/COMEBin), and/or [MetaBinner](https://github.com/ziyewang/MetaBinner)
5151
- 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/)
5252
- Performs ancient DNA validation and repair with [pyDamage](https://github.com/maxibor/pydamage) and [freebayes](https://github.com/freebayes/freebayes)
5353
- optionally refines bins with [DAS Tool](https://github.com/cmks/DAS_Tool)
@@ -60,12 +60,6 @@ Furthermore, the pipeline creates various reports in the results directory speci
6060
> [!NOTE]
6161
> 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.
6262
63-
```bash
64-
nextflow run nf-core/mag -profile <docker/singularity/podman/shifter/charliecloud/conda/institute> --input '*_R{1,2}.fastq.gz' --outdir <OUTDIR>
65-
```
66-
67-
or
68-
6963
```bash
7064
nextflow run nf-core/mag -profile <docker/singularity/podman/shifter/charliecloud/conda/institute> --input samplesheet.csv --outdir <OUTDIR>
7165
```
@@ -107,6 +101,7 @@ Other code contributors include:
107101
- [Nikolaos Vergoulidis](https://github.com/IceGreb)
108102
- [Greg Fedewa](https://github.com/harper357)
109103
- [Vini Salazar](https://github.com/vinisalazar)
104+
- [Alex Caswell](https://github.com/AlexHoratio)
110105

111106
Long read processing was inspired by [caspargross/HybridAssembly](https://github.com/caspargross/HybridAssembly) written by Caspar Gross [@caspargross](https://github.com/caspargross)
112107

assets/multiqc_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
report_comment: >
2-
This report has been generated by the <a href="https://github.com/nf-core/mag/releases/tag/5.1.0" target="_blank">nf-core/mag</a> analysis pipeline. For information about how to interpret these results, please see the <a href="https://nf-co.re/mag/5.1.0/docs/output" target="_blank">documentation</a>.
2+
This report has been generated by the <a href="https://github.com/nf-core/mag/releases/tag/5.2.0" target="_blank">nf-core/mag</a> analysis pipeline. For information about how to interpret these results, please see the <a href="https://nf-co.re/mag/5.2.0/docs/output" target="_blank">documentation</a>.
33
report_section_order:
44
"nf-core-mag-methods-description":
55
order: -1000

0 commit comments

Comments
 (0)