Skip to content

Latest commit

 

History

History
286 lines (217 loc) · 17.8 KB

CHANGELOG.md

File metadata and controls

286 lines (217 loc) · 17.8 KB

genomic-medicine-sweden/tomte: Changelog

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

TDB

Added

  • Optionally run Peddy for per-sample sex- and heterozygosity checks #190
  • Optionally calculate percentage mapping to hemoglobin genes (or any other set of genes provided) #190
  • Added the option of providing sex as 0, 1, or 2 as in the raredisease pipeline #192

Parameters

Old parameter New parameter
--skip_peddy
--skip_calculate_hb_frac
--hb_genes

3.0.0 - Three Kings [2024-11-18]

Added

  • Functionality to create DROP databases and to add samples to existing ones #147
  • A switch --skip_variant_calling for variant calling #169
  • Functionality to output DROP databases in references folder with a working sample annotation sheet #172
  • Added optional sex info col to samplesheet, used in DROP#168
  • Added more documentation regarding DROP #178

Fixed

  • Versions for all modules involving drop will now be outputed in version.yml and multiqc file #174
  • Fixed bug when running variant calling with gatk #182

Parameters

Old parameter New parameter
--max_cpus
--max_memory
--max_time
--validationShowHiddenParams
--validationSkipDuplicateCheck
--validationS3PathCheck
--monochromeLogs --monochrome_logs
--skip_variant_calling

Changed

  • Updated modules ensemblvep/filtervep, ensemblvep/vep #159
  • Updated gencode version from 37 to 46 #159
  • Updated modules using drop drop_config_runAE, drop_config_runAS, drop_sample_annot, and drop_filter_results #147
  • Updated nf-core/tools template to v3.0.2 #167
  • Updated multiqc version to 1.25.1 #167
  • Updated modules bcftools/annotate, bcftools/merge, bcftools/mpileup, bcftools/norm, bcftools/stats, bcftools/view, cat/fastq, ensemblvep/filtervep, ensemblvep/vep, fastp, gatk4/asereadcounter, gatk4/bedtointervallist, gatk4/createsequencedictionary, gatk4/haplotypecaller, gatk4/splitncigarreads, gatk4/variantfiltration, gawk, gffcompare, gunzip, picard/collectinsertsizemetrics, picard/collectrnaseqmetrics, salmon/index, salmon/quant, samtools/faidx, samtools/index, samtools/view, star/align, star/genomegenerate, stringtie/stringtie, tabix/bgziptabix, tabix/tabix, ucsc/wigtobigwig, untar #177
  • Changed how variant caller is added to the vcf, it is now done using the local module add_found_in_tag #184
Tool Old version New version
ensemblvep/filtervep 110 113
ensemblvep/vep 110 113
DROP 1.3.3 1.4.0
multiqc 1.21 1.25.1
cat/fastq 8.30 9.5
picard/collectinsertsizemtrics 3.2.0 3.3.0
salmon/index 1.10.1 1.10.3
salmon/quant 1.10.1 1.10.3
samtools/faidx 1.20 1.21
samtools/index 1.20 1.21
samtools/view 1.20 1.21
star/align 2.7.10a 2.7.11b
star/genomegenerate 2.7.10a 2.7.11b
stringtie/stringtie 2.2.1 2.2.3

2.2.1 - Scrooge [2024-08-28]

Fixed

  • After an update, MultiQC was not outputing data for RnaSeqMetrics so an earlier version will be used #156

Changed

  • Downgraded multiqc version #156
Tool Old version New version
multiqc 1.24.1 1.21

2.2.0 - TioDeNadal [2024-08-27]

Added

  • Fasta, gtf, vep cache and plugins can now be downloaded automatically by the pipeline if they are not provided by the user #149
  • Added --gencode_annotation_version, the version of the gencode reference version to download if fasta or gtf is not provided #149
  • Added the possibility to provide --vep_refs_download, a comma separated csv determining the vep references that should be downloaded (excluding gnomad ones) alongside with a switch --skip_download_vep for the vep reference download in general and --skip_download_gnomad for gnomad in particular #149

Fixed

  • Input to BootstrapAnn is now supplied in a single channel. Previously they were supplied in separate channels, which could cause mix-ups if more than one sample was supplied #151

Parameters

Old parameter New parameter
--gencode_annotation_version
--vep_refs_download
--skip_download_vep
--skip_download_gnomad

Note

Parameter has been updated if both old and new parameter information is present. Parameter has been added if just thenew parameter information is present. Parameter has been removed if new parameter information isn't present.

Changed

  • Updated modules bcftools/annotate, bcftools/mpileup, bcftools/view, cat/fastq, ensemblvep/filtervep, fastp, fastqc, gatk4/haplotypecaller, gatk4/splitncigarreads, gunzip, multiqc, picard/collectrnaseqmetrics, samtools/index, star/align, star/genomegenerate, stringtie/stringtie, tabix/bgziptabix, tabix/tabix and untar #153
Tool Old version New version
gunzip 20.04 22.04
multiqc 1.22.3 1.24.1
picard/collectinsertsizemetrics 3.1.1 3.2.0
tabix/bgziptabix 1.19.1 1.20
tabix/tabix 1.19.1 1.20
untar 20.04 22.04

2.1.0 - Elf [2024-06-26]

Added

  • Installed bcftools/norm #127
  • Installed bcftools/annotate #127

Fixed

  • One line per call on vcf to make vcf suitable for Scout #127
  • Added variant caller to vcf to make vcf suitable for Scout #127
  • Normalised calls in vcf #127
  • Removed regions parameter from ASEReadCounter to obtain ASE for all regions #129
  • Updated container for GET_CHROM_SIZES #132
  • Updated container for RENAME_FILES #132
  • Fixed GATK's ASEReadCounter by adding bcftools norm to avoid having duplicated positions in vcf #137

Parameters

Changed

  • Updated template to v2.14.1 #123
  • Changed DROP output column names to camel case #132
  • Updated bcftools view and norm to be able to create index within the actual module #137
  • Updated bcftools annot to be able to create index within the actual module #140
  • Updated modules bcftools/merge, bcftools/mpileup, bcftools/stats, ensemblvep/vep, fastp, gawk, multiqc, salmon/quant, samtools/faidx, samtools/index and samtools/view #141
  • Removed unused modules bcftools/index and tabix/bgzip #141
Tool Old version New version
bcftools/index 1.18
bcftools/merge 1.18 1.20
bcftools/mpileup 1.18 1.20
bcftools/norm 1.18 1.20
bcftools/stats 1.18 1.20
bcftools/view 1.18 1.20
fastp 0.23.4 0.23.4
gawk 5.1.0 5.3.0
multiqc 1.21 1.22.3
salmon/quant 1.10.1 1.10.1
samtools/faidx 1.19.2 1.20
samtools/index 1.19.2 1.20
samtools/view 1.19.2 1.20
tabix/bgzip 1.19.1

:::note Version has been updated if both old and new version information is present. Version has been added if just the new version information is present. Version has been removed if new version information isn't present. :::

2.0.1 - Grinch [2024-04-25]

Added

Fixed

  • Vep annotated research results will be published #115

Parameters

2.0.0 - Santa [2024-04-19]

Added

  • Added automatic tests to test the pipeline with all switches set to false #100
  • Added better documentation on subworkflow input #101
  • Added option to add extra arguments to DROP aberrant expression and aberrant splicing #104
  • Added a function to branch references into compressed/uncompressed #107
  • Added nf-core modules gawk and filter vep to create a clinical vcf #109

Fixed

  • Subsample and downsample switches #97
  • Now all reference files come with meta to avoid confusion #101
  • GATK4_ASEREADCOUNTER and GATK4_SPLITNCIGARREADS have been updated #101
  • Updated GATK4_ASEREADCOUNTER, now bam and vcf will be given as one channel #103
  • Prepare reference subworkflow has been reformated and simplified #105
  • FastQC have been updated to correctly allocate memory #106
  • vep_filters is now extracted from gene_panel_clinical_filter #109
  • Updated modules bcftools/stats, ensemblvep/vep, fastp, gatk4/bedtointervallist, samtools/faidx #110

Parameters

  • Removed --vep_filters, it will now be automatically extracted from the --gene_panel_clinical_filter#109

    Old parameter New parameter
    --vep_filters
  • Updated parameter names to make their use easier and more clear, changing the names from switch to skip and their default value from true to false #108

Old parameter New parameter
--switch_subsample_region --skip_subsample_region
--switch_downsample --skip_downsample
--switch_build_tracks --skip_build_tracks
--switch_stringtie --skip_stringtie
--switch_vep --skip_vep
--switch_drop_ae --skip_drop_ae
--switch_drop_as --skip_drop_as

:::note Parameter has been updated if both old and new parameter information is present. Parameter has been added if just the new parameter information is present. Parameter has been removed if new parameter information isn't present. :::

1.1.0 - Rudolph [2024-03-11]

Release of genomic-medicine-sweden/tomte, created with the nf-core template.

Added

  • switch_vep, switch_build_tracks and switch_stringtie to make the pipeline more versatile #61
  • Updated template and nf-tools #65
  • Use nf-validation plugin for parameter and samplesheet validation #66
  • Installed the nf-core version of ensemblvep/vep module #67
  • A new parameter vep_plugin_files to supply files required by vep plugins #67
  • The possibility of using igenomes_base to point to a path where genome specific reference files are placed (fasta, fai, gtf, star_index, salmon_index, subsample_bed) #76
  • Merging of case's vcf files #80
  • Reference list to MultiQC report #88
  • Added module to calculate insert size and added results to MultiQC report #90

Fixed

  • Renamed the other switches (subsample_region_switch, downsample_switch, run_drop_ae_switch and run_drop_as_switch) so that they all start with switch* (switch_subsample_region, switch_downsample, switch_drop_ae and switch_drop_as) #61
  • Separated modules.config into smaller configs #61
  • Missing fasta_fai channel when fai file is given #63
  • DROP output file columns, removing duplicate column and adding same ids to both AE and AS #68
  • Patch tools update and case ID parsing #71
  • Naming of DROP output files #72
  • VEP plugin schema to allow for directories #74
  • Made params.platform into a channel #75
  • Changed name of salmon's quant.nf to include sample id #78
  • Shortened name of DROP output files #79
  • Merging of vcfs has been moved to after bootstrapAnn #81
  • Substituted bgzip and tabix modules by bgzip_tabix module #85
  • Updated module input channels in the GATK variant calling subworkflow #89

Dependencies

Deprecated

1.0.0 - Nisse [2023-11-06]

Added

  • Trim reads with FASTP
  • Read mapping with STAR
  • Transcript quantification with Salmon
  • Output junction tracks
  • Output bigwig
  • Choice to subsample overrepresented regions with Samtools
  • Choice to downsample number of reads with Samtools
  • Detection of aberrant expression with DROP
  • Detection of aberrant splicing with DROP
  • Filter aberrant expression and aberrant splicing results
  • Guided transcript assembly with StringTie
  • Filtering results of guided transcript assembly with GffCompare
  • SNVs calling with GATK or BCFtools Mpileups
  • Allele Specific Read Counter with ASEReadCounter
  • Assess allelic imbalance with BootstrapAnn
  • Annotation with VEP
  • Alignment QC with Picard CollectRnaSeqMetrics
  • Present QCs with MultiQC