Version history

3.12.0 - Njoatsosvágge

Njoatsosvágge is a long valley crossing the northern part of Sarek National Park.

Added

Addition of:

  • Parabricks MutectCaller with --tools parabricks_mutectcaller, a GPU-accelerated somatic variant caller for tumor-only and tumor/normal samples. Its calls are filtered with GATK FilterMutectCalls, including read-orientation priors and contamination estimation.
  • --force_call_alleles and --force_call_alleles_tbi to force-call alleles from a VCF with Mutect2 and Parabricks MutectCaller, based on work by @jchchiu.
  • --contamination_resource and --contamination_resource_tbi to give GATK GetPileupSummaries a set of common biallelic SNPs instead of --germline_resource.
  • --mosdepth_fast_mode to control Mosdepth fast mode for whole-genome coverage. Fast mode stays enabled by default.

Bug fixes

  • Fix --intervals handling: the BED is now sorted in reference order, which fixes CalculateContamination failing with Invalid interval. The run now fails early for contigs missing from the reference, start > end, and intervals past the contig end, before any process starts when --fasta_fai is provided. BED files with track, browser or # header lines no longer fail the run.
  • Fail when --no_intervals is combined with --intervals, which it would ignore, and restore --intervals false to generate intervals from the FASTA.
  • Fix fgbio crashes during UMI consensus calling with bwa-mem2 by running samtools fixmate first.
  • Fix the DeepSomatic VCF merge failing when an interval yields no records, such as *_alt contigs.
  • Fix Join mismatch in post-variant-calling for --tools tiddit with --filter_vcfs, --normalize_vcfs or --concatenate_vcfs.
  • Fix MSIsensorPro analysing only the first tumor/normal pair when --msisensorpro_scan is provided, and publish its _all and _unstable outputs.
  • Fix csv/variantcalled.csv pointing at a directory instead of the published VCFs, and consensus VCFs intermittently being listed in the wrong folder.
  • Pass the Mutect2 and Parabricks MutectCaller stats file to FilterMutectCalls.
  • Fix validation for --step annotate.

Improvements

  • Update Parabricks to 4.8.0 and FastQC to 0.13.0.
  • Add bedtools 2.31.1 for interval sorting.
  • Mutect2 and Parabricks MutectCaller share one GATK filtering subworkflow.
  • Clarify the documentation for annotation caches and software versions, the <patient>_<sample> read group name required for BAM/CRAM input to somatic callers, and MSI analysis.
  • Update the pipeline template to nf-core/tools 4.2.1.

Important changes

  • The process MUTECT2_PAIRED is now MUTECT2. Custom configs using withName: 'MUTECT2_PAIRED' need to select MUTECT2 instead.
  • Mutect2 calls are now always filtered with FilterMutectCalls, also without --germline_resource. Downstream files of such runs are named after *.mutect2.filtered.vcf.gz.
  • With --joint_mutect2, tumors of one patient with different contamination values in the samplesheet no longer split the patient into several joint calls.
  • CNVKit target and antitarget BED names now carry the .sorted suffix of the sorted intervals file.
  • csv/variantcalled.csv now points at the published filtered, normalized, concatenated and Varlociraptor VCFs.

New parameters

  • --contamination_resource
  • --contamination_resource_tbi
  • --force_call_alleles
  • --force_call_alleles_tbi
  • --mosdepth_fast_mode

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.11.0...3.12.0

What’s Changed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.10.0...3.11.0

3.10.0 - Aktse

Added

Addition of:

  • Parabricks HaplotypeCaller with --tools parabricks_haplotypecaller by @gburnett-nvidia. This currently produces per-sample VCFs and does not support joint germline calling.
  • Varlociraptor FDR filtering for germline, somatic and tumor-only workflows by @famosab.

Bug fixes

  • Fix --normalize_vcfs dropping an allele from multiallelic sites by @apolitics.
  • Fix VEP LoFTEE plugin execution with Conda.
  • Skip nf-schema path validation for --annotation_cache and --igenomes_base by @pinin4fjords.

Improvements

  • Prepare the pipeline for Nextflow strict syntax and Nextflow 26.
  • Migrate modules to topic channels.
  • Update Ensembl VEP to 116.0 by @maxulysse.
  • Update bcftools to 1.23.1 by @famosab.
  • Update Parabricks to 4.7.1, GATK to 4.6.2, samtools to 1.24, mosdepth to 0.3.14 and several other dependencies.
  • Update the pipeline template to nf-core/tools 4.1.0.

Important changes

  • Somatic FreeBayes no longer uses --pooled-discrete, and its default minimum alternative allele fraction changes from 0.03 to 0.01.
  • When starting from CRAM or BAM files with --step variant_calling, CNVKit output names are now based on the input filename instead of the sample name. FASTQ-based workflows are unaffected.
  • The output format of GATK4_APPLYBQSR and GATK4SPARK_APPLYBQSR can no longer be changed using ext.suffix.

New parameters

  • --varlociraptor_events_germline
  • --varlociraptor_events_somatic
  • --varlociraptor_events_tumor_only
  • --varlociraptor_fdr

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.9.0...3.10.0

What’s Changed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.8.1...3.9.0

Added

Addition of the following tools:

  • VEP Condel plugin to calculate Consensus Deleteriousness scores for missense mutations
  • VEP Mastermind plugin to retrieve citation counts from Mastermind Genomic Search Engine
  • VEP Phenotypes plugin to retrieve overlapping phenotype information from Ensembl databases
  • SnpSift annotation support using --tools snpsift with --snpsift_databases CSV configuration

Bug fixes

Improvements

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.7.1...3.8.0

What’s Changed

Full Changelog: https://github.com/nf-core/sarek/compare/3.7.0...3.7.1

What’s Changed

New Tools

New Parameters:

  • --filter_vcfs - Enable VCF filtering
  • --bcftools_filter_criteria - Filter criteria for bcftools
  • --snv_consensus_calling - Enable consensus calling
  • --consensus_min_count - Minimum tool count for consensus

Bug Fixes:

Developer Changes:

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.6.1...3.7.0

What’s Changed

This release contains a fix for --aligner parabricks to use the correct intervals channel when running with --wes or --intervals <file> see #2029.

This patch release includes a bump to Nextflow 25.04.8.

Full Changelog: https://github.com/nf-core/sarek/compare/3.6.0...3.6.1

What’s Changed

Main new features

🧬 Lots of improvements around UMI support (#1937, @SPPearce) ⏩ Parabricks support (#1804, @famosab) 🔍 Muse (#1744, @famosab) and Sentieon TNScope (#1934, @SPPearce) 📜 MSISensor2 (#1965, @maxulysse) 🦖 Varlociraptor (#1940, @famosab) ◀️ Normalization of variants (#1770, @Patricie34 & @maxulysse) 🖖 bbsplit (#1983, @apsteinberg, @tobsecret & @FriederikeHanssen)

Changed

  • Version updates:
    • VEP cache updated to v115.2
    • SnpEff updated to v5.3.0a (SnpEff cache downgraded to 99 since 105 is not available at the moment)
    • GATK4 to 4.6.1.0
    • DeepVariant to 1.9.0
    • Freebayes to 1.3.10 with QUAL filtering
  • Workflow improvements:
    • Enhanced metro map
    • Doubled default process time
    • Improved sample validation
  • Complete test migration:
    • All pytest tests migrated to nf-test framework for better testing infrastructure

Fixed

New Parameters

  • --freebayes_filter
  • --msisensor2_models
  • --sentieon_consensus
  • --umi_base_skip
  • --umi_in_read_header
  • --umi_length
  • --umi_location
  • --umi_tag
  • --varlociraptor_chunk_size
  • --varlociraptor_scenario_germline
  • --varlociraptor_scenario_somatic
  • --varlociraptor_scenario_tumor_only

Full Changelog: 3.5.1…3.6.0

What’s Changed

Changed

Fixed

Full Changelog: https://github.com/nf-core/sarek/compare/3.5.0...3.5.1

What’s Changed

Added

Changed

Fixed

Removed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.4.4...3.5.0

What’s Changed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.4.3...3.4.4

What’s Changed

Added

Changed

Fixed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.4.2...3.4.3

What’s Changed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.4.1...3.4.2

https://github.com/nf-core/sarek/blob/master/CHANGELOG.md#342---s%C3%A1jt%C3%A1ristj%C3%A5hkk%C3%A5

What’s Changed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.4.0...3.4.1

What’s Changed

New tools:

Refactoring

Bug fixes and other updates

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.3.2...3.4.0

What’s Changed

Full Changelog: https://github.com/nf-core/sarek/compare/3.3.1...3.3.2

What’s Changed

Full Changelog: https://github.com/nf-core/sarek/compare/3.3.0...3.3.1

What’s Changed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.2.3...3.3.0

What’s Changed

Full Changelog: https://github.com/nf-core/sarek/compare/3.2.1...3.2.2

What’s Changed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.1.2...3.2.0

What’s Changed

Full Changelog: https://github.com/nf-core/sarek/compare/3.0.2...3.1

What’s Changed

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/3.0.1...3.0.2

  • Porting to DSL2
  • Use CRAM files where possible
  • Add new tools: DragMap, DeepVariant, Joint germline calling, Haplotypecaller single sample, CNVKit Somatic, Tiddit Somatic
  • Replaced tools: Trimgalore -> Fastp, Qualimap -> Mosdepth
  • New references: BWAMem2, DragMap, Germline Resource
  • Add a new entry --step markduplicates
  • Steps can be started from bam or cram files
  • Added --paired_variant_calling_only to skip normal computations for paired samples
  • Only unmatched tumor samples will be run in single mode
  • Input fastq files are split by default and mapped in parallel
  • Bam2Fastq: changed to using samtools
  • Samplesheet is now in CSV format with a header line with improved validation and flexibility
  • New parameter --skip_tools retires --skip_qc, --skip_markduplicates and --skip_bqsr
  • --sequencing_center renamed to –seq_platform`
  • New parameter --wes must be set for targeted data
  • New parameter --save_bam_ouput to store results file in BAM format instead of CRAM
  • Additional VEP output formats
  • Additional VEP plugins: loftee, spliceAI, spliceRegions, dbnsfp
  • Remove sentieon support

New Contributors

Full Changelog: https://github.com/nf-core/sarek/compare/2.7.2...3.0