Version history

v1.1.2 - 2026-06-03

Added

  • Add param --cluster_with_reference_pool to optionally include the reference pool in the clustering step (#278) (by @nrminor, @Joon-Klaps)
  • Template update to nf-core/tools v4.0.2 (#289) (by @Joon-Klaps)
  • Bump version from dev to 1.1.2 for release (#292) (by @Joon-Klaps)

Fixed

  • Cast Lazymaps to Hashmaps to become thread safe with various groovy operators (#291) (by @aersoares81, @Joon-Klaps)
  • Extract Python package versions via python -c "import X; print(X.__version__)" instead of pip show, so versions are recorded reliably across conda/pip layouts (#292) (by @Joon-Klaps)

Dependencies

Dependency Old version New version
nf-schema 2.5.1 2.7.2
nft-utils 0.0.3 1.0.0

Parameters

Old parameter New parameter
--cluster_with_reference_pool

NB: Parameter has been updated if both old and new parameter information is present. NB: Parameter has been added if just the new parameter information is present.

Added

  • Template update for nf-core/tools v3.5.2 (#270) (by @Joon-Klaps)
  • Modules update to latest nf-core versions (#271) (by @Joon-Klaps)
  • Update local modules to use topics (#272) (by @Joon-Klaps)
  • Add better output file descriptions for prokka #274 (by @Joon-Klaps)
  • Better item descriptors (it -> [it[0], it[1] to meta, fasta , _foo -> [meta,fasta]) for better readability (#265) (by @Joon-Klaps)
  • Include the new parameter --transpose_overview_tables , fixes #220 (#275) (by @Joon-Klaps)
  • Bump version from dev to 1.1.1 for release (#277) (by @Joon-Klaps)

Fixed

  • Follow the rules of strict syntax health #265 (by @Joon-Klaps)
  • Moved the module specifics from base.config to modules.config (#265)
  • Fix bug from regex in input schema still allowing underscores in sample and group names (#269) - (by @Joon-Klaps)

Dependencies

Dependency Old version New version
snpeff 5.3.0a 5.4.0a

Parameters

Old parameter New parameter
--transpose_overview_tables

NB: Parameter has been updated if both old and new parameter information is present. NB: Parameter has been added if just the new parameter information is present.

v1.1.0 - 2026-01-23

Added

  • Add subworkflow tests of fasta_fastq_clust and fasta_contig_clust #253 (by @Joon-Klaps)
  • Add subworkflow tests for preprocessing_illumina and fastq_fastqc_umitools_trimmomatic #255 (by @Joon-Klaps)

Fixed

  • Fix memory issues for network_cluster #105 by switching to Clusty #251 (by @Joon-Klaps)
  • Improve memory efficiency and speed of FASTA sequence extraction #252 (by @Joon-Klaps)
  • Fix bug of clusty not handling single genome distance files well #253 (by @Joon-Klaps)
  • Fix reported trimmomatic bug #254 ‘no such variable “trim_read_count”’ #255 (by @Joon-Klaps)
  • Fix descrepancy of documentation and actual arguments #256 (by @Joon-Klaps)
  • Fix performance issues with extract_cluster.py for large datasets #259 (by @Joon-Klaps)

Dependencies

Dependency Old version New version
clusty N/A 1.2.2

v1.0.1 - 2025-12-03

Added

Fixed

  • Template merge from nf-core/tools v3.5.1 (#236) (by @Joon-Klaps)
  • Fix bug with numeric sample ids in custom_multiqc.py module (#243) (by @Joon-Klaps)
  • Fix runtime environment migration of network_cluster from custom docker repo to seqera containers (#247) (by @Joon-Klaps)

Dependencies

Dependency Old version New version
bcftools 1.21 1.22
blast 2.16.0 2.17.0
bwa-mem2 2.2.1 2.3
coreutils 9.4 9.5
fastp 0.24.0 1.0.1
htslib 1.21 1.22.1
kraken2 2.1.5 2.1.6
krakentools 1.2 1.2.1
mmseqs2 17.b804f 18.8cc5c
mosdepth 0.3.10 0.3.11
picard 3.3.0 3.4.0
samtools 1.21 1.22.1
snpeff 5.1 5.3.0a
umitools extract 1.1.5 1.1.6

v1.0.0 - 2025-11-04

Initial release of nf-core/viralmetagenome, created with the nf-core template.

Added

  • Add argument to control the maximum mpileup depth in custom_mpileup.py script (#176) (by @Joon-Klaps)
  • Removing redundant samtools_sort after BAM_DEDUPLICATE (#177) (by @Joon-Klaps)
  • Removing seqkit replace and move logic to blast_filter.py (#178) (by @Joon-Klaps)
  • Giving Kaiju more memory (#179) (by @Joon-Klaps)
  • Add option for sample merging based on group column in samplesheet (#180) (by @Joon-Klaps)
  • Creating testdatasets using nf-core repo (#183) (by @Joon-Klaps)
  • Add option to annotate snps with Snpeff for mapping constraint route (#186) (by @Joon-Klaps)
  • Add nf-tests for test profile (#189) (by @Joon-Klaps)
  • Update docs (#200) (by @Joon-Klaps)
  • Template update for nf-core/tools v3.3.2 (#202) (by @Joon-Klaps)
  • Add option for local desktop configuration profile (#227) (by @Joon-Klaps)
  • Added option to blacklist certain NCBI accessions (--blacklist) from reference pool (--reference_pool) (#228) (by @Joon-Klaps)
  • Add support for both string and integer inputs in samplesheets through validation.lentientMode = true (#230) (by @Joon-Klaps)

Fixed

  • Fix local module ivar_variants_to_vcf to handle empty tsv files (#197) (by @Joon-Klaps)
  • Migrate lib dir functions to utils_nfcore_viralmetagenome_pipeline (#194) (by @Joon-Klaps)
  • Fix inconsistent dependency versions across modules (#208) (by @Joon-Klaps)
  • Fix conda issue unrecognized arguments: –mkdir (#210) (by @Joon-Klaps)
  • Fix writing no sequence for select_reference.py to the first reference of the multifasta (#214) (by @Joon-Klaps)
  • Fix main language detection to ignore generated files (#224) (by @Joon-Klaps)

Deprecated

Second release of the viralgenie pipeline. Focusing on user experience and bug fixes.

Enhancement

  • Set default umitools dedup strategy to cluster (#126)
  • Include both krakenreport &nodes.dmp in taxonomy filtering (#128)
  • Add Sspace indiv to each assembler seperatly (#132)
  • Add read & contig decomplexification using prinseq++ (#133)
  • Add option to filter contig clusters based on cumulative read coverage (#138)
  • Reffurbish mqc implementation (#139)
  • Adding mash-screen output to result table (#140)
  • Add logic to allow samples with no reference hits to be analysed (#141)
  • Add visualisation for hybrid scaffold (#143)
  • Add new module to inculde custom mpileup-vcf file for intra-host analyses (#151)
  • Update docs (#150)
  • Make custom-mpileup.py postion 1 index based and not 0 index to follow bcftools (#153)
  • Update docs for more streamlined docs & figures (#154)
  • Add column in custom mpileup - Shannon entropy (#156)
  • Constrain -> Constraint & further python script debugging (#161)
  • include empty samples in multiqc sample overview (#162)
  • Include samtools stats pre dedup & post dedup in overview tables (#163)
  • adding prokka for gene detection & annotation (#165)

Fixed

  • OOM with longer contigs for nocov_to_reference, uses more RAM now (#125)
  • fixing null output from global prefix (#147)
  • Fix empty filtered clusters (#148)
  • Fixing missing columns from general stats & add general stats sample filtering (#149)
  • process.shell template fix (#157) - see also nf-core/tools #3416

Parameters

  • DEPRECATED- New parameter mmseqs_cluster_mode default to 0 (#130)
  • Refactor module arguments to pipeline arguments (#166)

Initial pre-release with core functionalities.

What’s Changed