You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+60-29Lines changed: 60 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,38 @@
3
3
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
4
4
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5
5
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)
-[#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]
7
38
8
39
### `Added`
9
40
@@ -30,7 +61,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
30
61
31
62
### `Deprecated`
32
63
33
-
## 5.0.0 - [2025-09-30]
64
+
## v5.0.0 - Green Squirrel[2025-09-30]
34
65
35
66
### `Added`
36
67
@@ -102,7 +133,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
102
133
-[#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)
103
134
-[#864](https://github.com/nf-core/mag/pull/864) - Remove `--gtdb_mash` due to dropping of support by GTDBTk itself (by @prototaxites and @jfy133)
104
135
105
-
## v4.0.0 - [2025-05-22]
136
+
## v4.0.0 - Blue Huemul [2025-05-22]
106
137
107
138
### `Added`
108
139
@@ -138,7 +169,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
138
169
139
170
-[#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)
140
171
141
-
## 3.4.0 [2025-04-04]
172
+
## v3.4.0 - Green Gecko[2025-04-04]
142
173
143
174
### `Added`
144
175
@@ -187,7 +218,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
187
218
188
219
### `Deprecated`
189
220
190
-
## 3.3.0 [2024-12-19]
221
+
## v3.3.0 - Red Reindeer[2024-12-19]
191
222
192
223
### `Added`
193
224
@@ -222,7 +253,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
222
253
223
254
### `Deprecated`
224
255
225
-
## 3.2.1 [2024-10-30]
256
+
## v3.2.1 [2024-10-30]
226
257
227
258
### `Added`
228
259
@@ -236,7 +267,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
236
267
237
268
### `Deprecated`
238
269
239
-
## 3.2.0 [2024-10-27]
270
+
## v3.2.0 - Salmon Salmon[2024-10-27]
240
271
241
272
### `Added`
242
273
@@ -268,7 +299,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
268
299
269
300
### `Deprecated`
270
301
271
-
## 3.1.0 [2024-10-04]
302
+
## v3.1.0 - Pink Panda[2024-10-04]
272
303
273
304
### `Added`
274
305
@@ -296,7 +327,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
296
327
297
328
-[#670](https://github.com/nf-core/mag/pull/670) - Deprecated `--gtdbtk_pplacer_scratch` due to unintuitive usage (reported by harper357, fixed by @jfy133)
298
329
299
-
## 3.0.3 [2024-08-27]
330
+
## v3.0.3 [2024-08-27]
300
331
301
332
### `Added`
302
333
@@ -315,7 +346,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
315
346
316
347
### `Deprecated`
317
348
318
-
## 3.0.2 [2024-07-04]
349
+
## v3.0.2 [2024-07-04]
319
350
320
351
### `Added`
321
352
@@ -338,7 +369,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
338
369
339
370
### `Deprecated`
340
371
341
-
## 3.0.1 [2024-06-10]
372
+
## v3.0.1 [2024-06-10]
342
373
343
374
### `Added`
344
375
@@ -358,7 +389,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
358
389
359
390
### `Deprecated`
360
391
361
-
## 3.0.0 - [2024-05-13]
392
+
## v3.0.0 - Magenta Magpie[2024-05-13]
362
393
363
394
### `Added`
364
395
@@ -379,7 +410,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
379
410
380
411
-[#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)
381
412
382
-
## 2.5.4 -[2024-02-12]
413
+
## v2.5.4 [2024-02-12]
383
414
384
415
### `Added`
385
416
@@ -396,7 +427,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
396
427
397
428
### `Deprecated`
398
429
399
-
## 2.5.3 -[2024-02-05]
430
+
## v2.5.3 [2024-02-05]
400
431
401
432
### `Added`
402
433
@@ -412,7 +443,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
412
443
413
444
### `Deprecated`
414
445
415
-
## 2.5.2 -[2024-02-02]
446
+
## v2.5.2 [2024-02-02]
416
447
417
448
### `Added`
418
449
@@ -437,7 +468,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
437
468
438
469
### `Deprecated`
439
470
440
-
## 2.5.1 -[2023-11-17]
471
+
## v2.5.1 [2023-11-17]
441
472
442
473
### `Added`
443
474
@@ -459,7 +490,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
459
490
460
491
-[#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)
461
492
462
-
## 2.5.0 - [2023-10-10]
493
+
## 2.5.0 - Aquamarine Kangaroo - [2023-10-10]
463
494
464
495
### `Added`
465
496
@@ -484,7 +515,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
484
515
485
516
-[#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).
486
517
487
-
## 2.4.0 - 2023-09-26
518
+
## v2.4.0 - Grey Hammerhead [2023-09-26]
488
519
489
520
### `Added`
490
521
@@ -548,7 +579,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
548
579
-[#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))
549
580
-[#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) )
550
581
551
-
## v2.3.0 - [2023/03/02]
582
+
## v2.3.0 - Red Cow [2023-03-02]
552
583
553
584
### `Added`
554
585
@@ -585,7 +616,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
585
616
| Freebayes | 1.3.5 | 1.3.6 |
586
617
| SAMtools | 1.15 | 1.16.1 |
587
618
588
-
## v2.2.1 - 2022/08/25
619
+
## v2.2.1 [2022-08-25]
589
620
590
621
### `Added`
591
622
@@ -598,7 +629,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
598
629
599
630
### `Dependencies`
600
631
601
-
## v2.2.0 - 2022/06/14
632
+
## v2.2.0 - Golden Mammoth [2022-06-14]
602
633
603
634
### `Added`
604
635
@@ -631,7 +662,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
631
662
| fastp | 0.20.1 | 0.23.2 |
632
663
| MultiQC | 1.11 | 1.12 |
633
664
634
-
## v2.1.1 - 2021/11/25
665
+
## v2.1.1 [2021-11-25]
635
666
636
667
### `Added`
637
668
@@ -654,7 +685,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
-[#258](https://github.com/nf-core/mag/pull/258) - FastP results are now in MultiQC.
656
687
657
-
## v2.1.0 - 2021/07/29
688
+
## v2.1.0 - Black Zebra [2021-07-29]
658
689
659
690
### `Added`
660
691
@@ -670,7 +701,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
670
701
671
702
-[#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.
672
703
673
-
## v2.0.0 - 2021/06/01
704
+
## v2.0.0 - Silver Swan [2021-06-01]
674
705
675
706
### `Added`
676
707
@@ -705,7 +736,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
-[#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)
707
738
708
-
## v1.2.0 - 2021/02/10
739
+
## v1.2.0 - Yellow Squirrel [2021-02-10]
709
740
710
741
### `Added`
711
742
@@ -725,7 +756,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
Copy file name to clipboardExpand all lines: CITATIONS.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,6 +52,10 @@
52
52
53
53
> 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
> 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.
> 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
Copy file name to clipboardExpand all lines: README.md
+2-7Lines changed: 2 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ The pipeline then:
47
47
- 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)
48
48
- (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)
49
49
- 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)
- 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/)
52
52
- Performs ancient DNA validation and repair with [pyDamage](https://github.com/maxibor/pydamage) and [freebayes](https://github.com/freebayes/freebayes)
53
53
- 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
60
60
> [!NOTE]
61
61
> 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.
62
62
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
-
69
63
```bash
70
64
nextflow run nf-core/mag -profile <docker/singularity/podman/shifter/charliecloud/conda/institute> --input samplesheet.csv --outdir <OUTDIR>
71
65
```
@@ -107,6 +101,7 @@ Other code contributors include:
Long read processing was inspired by [caspargross/HybridAssembly](https://github.com/caspargross/HybridAssembly) written by Caspar Gross [@caspargross](https://github.com/caspargross)
Copy file name to clipboardExpand all lines: assets/multiqc_config.yml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
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>.
0 commit comments