Releases: TheJacksonLaboratory/cs-nf-pipelines
v0.3.0
Release v0.3.0
In this major release we have added two additional pipelines, added flexibility for specifying inputs via sample sheets, support for downloading remote input data, support for GRCm39, support for PDX data, and many more changes detailed below. Additionally, we have added the concept of "subworkflows" for tasks that are more complex than a module and/or involve multiple containers, yet can be potentially re-used in multiple pipelines.
Pipelines Added:
- ChIP-seq - human, mouse
- Paired Tumor Analysis (somatic/germline WGS) - human, PDX
- RNA Fusion - human, PDX
Subworkflows Added:
- Aria download for remote input data
- Concatenate paired tumor/normal FASTQ files
- RNA-seq for PDX input data
Modules Added:
- arriba/arriba.nf
- bamtools/bamtools_filter.nf
- bcftools/bcftools_germline_filter.nf
- bcftools/bcftools_intersect_lancet_candidates.nf
- bcftools/bcftools_merge_callers.nf
- bcftools/bcftools_remove_spanning.nf
- bcftools/bcftools_split_multiallelic_regions.nf
- bcftools/bcftools_split_multiallelic.nf
- bedtools/bedtools_amplicon_metrics.nf
- bedtools/bedtools_genomecov.nf
- bedtools/bedtools_start_candidates.nf
- biqseq2/bicseq2_normalize.nf
- biqseq2/bicseq2_seg_unpaired.nf
- biqseq2/bicseq2_seg.nf
- conpair/conpair_pileup.nf
- conpair/conpair.nf
- cosmic/cosmic_add_cancer_resistance_mutations_germline.nf
- cosmic/cosmic_add_cancer_resistance_mutations_somatic.nf
- cosmic/cosmic_annotation_somatic.nf
- cosmic/cosmic_annotation.nf
- deeptools/deeptools_computematrix.nf
- deeptools/deeptools_plotfingerprint.nf
- deeptools/deeptools_plotheatmap.nf
- deeptools/deeptools_plotprofile.nf
- ensembl/varianteffectpredictor_germline.nf
- ensembl/varianteffectpredictor_somatic.nf
- fastq-tools/fastq-pair.nf
- fastq-tools/fastq-sort.nf
- fusion_report/fusion_report.nf
- fusioncatcher/fusioncatcher.nf
- gatk/gatk_cnnscorevariants.nf
- gatk/gatk_combinegvcfs.nf
- gatk/gatk_filtermutectcalls_tumorOnly.nf
- gatk/gatk_filtermutectcalls.nf
- gatk/gatk_filtervarianttranches.nf
- gatk/gatk_genotype_gvcf.nf
- gatk/gatk_getsamplename_noMeta.nf
- gatk/gatk_getsamplename.nf
- gatk/gatk_haplotypecaller_sv_germline.nf
- gatk/gatk_mergemutectstats.nf
- gatk/gatk_mutect2_tumorOnly.nf
- gatk/gatk_mutect2.nf
- gatk/gatk_sortvcf_germline.nf
- gatk/gatk_sortvcf_somatic_merge.nf
- gatk/gatk_sortvcf_somatic_tools.nf
- gatk/gatk_variantfiltration_af.nf
- gatk/gatk_variantfiltration_mutect2.nf
- gatk/gatk3_applyrecalibration.nf
- gatk/gatk3_genotypegvcf.nf
- gatk/gatk3_haplotypecaller.nf
- gatk/gatk3_indelrealigner.nf
- gatk/gatk3_realignertargetcreator.nf
- gatk/gatk3_variantannotator.nf
- gatk/gatk3_variantrecalibrator.nf
- gridss/gridss_assemble.nf
- gridss/gridss_calling.nf
- gridss/gridss_chrom_filter.nf
- gridss/gridss_preprocess.nf
- gridss/gripss_somatic_filter.nf
- homer/annotate_boolean_peaks.nf
- homer/homer_annotatepeaks.nf
- homer/plot_homer_annotatepeaks.nf
- illumina/manta.nf
- illumina/strelka2.nf
- jaffa/jaffa.nf
- kallisto/kallisto_insert_size.nf
- kallisto/kallisto_quant.nf
- lumpy_sv/lumpy_sv.nf
- macs2/macs2_consensus.nf
- macs2/macs2_peak_calling_chipseq.nf
- macs2/plot_macs2_qc.nf
- msisensor2/msisensor2_tumorOnly.nf
- msisensor2/msisensor2.nf
- multiqc/multiqc_custom_phantompeakqualtools.nf
- novocraft/novosort.nf
- nygc-short-alignment-marking/short_alignment_marking.nf
- nygenome/lancet_confirm.nf
- nygenome/lancet.nf
- phantompeakqualtools/phantompeakqualtools.nf
- picard/picard_cleansam.nf
- picard/picard_collectmultiplemetrics.nf
- picard/picard_collecttargetpcrmetrics.nf
- picard/picard_fix_mate_information.nf
- picard/picard_mergesamfiles.nf
- pizzly/pizzly.nf
- preseq/preseq.nf
- primerclip/primerclip.nf
- python/python_add_final_allele_counts.nf
- python/python_add_nygc_allele_counts.nf
- python/python_check_strandedness.nf
- python/python_filter_pon.nf
- python/python_filter_vcf.nf
- python/python_germline_vcf_finalization.nf
- python/python_get_candidates.nf
- python/python_merge_columns.nf
- python/python_merge_prep.nf
- python/python_remove_contig.nf
- python/python_rename_metadata.nf
- python/python_rename_vcf.nf
- python/python_reorder_vcf_columns.nf
- python/python_snv_to_mnv_final_filter.nf
- python/python_somatic_vcf_finalization.nf
- python/python_split_mnv.nf
- python/python_vcf_to_bed.nf
- r/annotate_bicseq2_cnv.nf
- r/annotate_genes_sv.nf
- r/annotate_sv_with_cnv.nf
- r/annotate_sv.nf
- r/filter_bedpe.nf
- r/frag_len_plot.nf
- r/merge_sv.nf
- samtools/samtools_faidx.nf
- samtools/samtools_filter_unique_reads.nf
- samtools/samtools_filter.nf
- samtools/samtools_mergebam_filter.nf
- samtools/samtools_stats_insertsize.nf
- samtools/samtools_stats.nf
- samtools/samtools_view.nf
- squid/squid_annotate.nf
- squid/squid_call.nf
- star/star_align.nf
- star-fusion/star-fusion.nf
- subread/subread_feature_counts_chipseq.nf
- svaba/svaba.nf
- tabix/compress_merged_vcf.nf
- tabix/compress_vcf_region.nf
- tabix/compress_vcf.nf
- ucsc/ucsc_bedgraphtobigwig.nf
- utility_modules/aria_download.nf
- utility_modules/chipseq_bampe_rm_orphan.nf
- utility_modules/chipseq_check_design.nf
- utility_modules/chipseq_make_genome_filter.nf
- utility_modules/concatenate_reads_sampleSheet.nf
- utility_modules/deseq2_qc.nf
- utility_modules/frip_score.nf
- utility_modules/get_read_length.nf
- utility_modules/gunzip.nf
- utility_modules/jax_trimmer.nf
- utility_modules/parse_extracted_sv_table.nf
- xenome/xenome.nf
Pipeline Changes:
- WES, RNA-seq, and RNA-fusion added support for PDX data
- WES, RNA-seq, WGS, ATAC, RRBS, ChIP added support for GRCm39
- Support for input specification using sample sheets for ATAC, RNA-seq, RRBS, WES, WGS
- Support for downloading input data for ATAC, RNA-seq, RRBS, WES, WGS
- Added MULTIQC to ATAC, RNA-seq, RRBS, WES, WGS
- Added assessment of strandedness using python/python_check_strandedness.nf rather than requiring specification via parameters
- Added assessment of read length for RNAseq for STAR index selection rather than requiring specfication via parameters
- Modified variant annotations in WES and WGS
- Added GVCF support for WES and WGS
Module Changes:
- errorStrategy modified for all modules to catch and report instances where tasks fail due to walltime or memory contraints. This previously required a deep reading of the subtask SLURM logs, but now will be reported in the top-level SLURM log and is more user-friendly
- Removed log.info statements from modules to avoid noisy disruption of log files
- ChIP-seq support for bwa/bwa_mem.nf, fastqc/fastqc.nf, picard/picard_markduplicates.nf, trim_galore/trim_galore.nf
- Corrected emit statements for g2gtools/g2gtools_chain_convert_peak.nf
- Corrected emit statements for gatk/gatk_chain_filter_reads.nf
- Modified gatk/gatk_haplotypecaller_interval.nf and gatk/gatk_haplotypecaller.nf for optional GVCF support
- Generalized multiqc/multiqc.nf via parameter for multiqc config
- Removed --METRIC_ACCUMULATION_LEVEL ALL_READS and --VALIDATION_STRINGENCY LENIENT parameters from picard/picard_collectalignmentsummarymetrics.nf
- Modified strand specification logic for picard/picard_collectrnaseqmetrics.nf
- Updated rsem/rsem_alignment_expression.nf to reflect changes in strandedness detection, reorganized outputs and catching log files for multiqc
- Changes to output text for mt DNA content in samtools/samtools_calc_mtdna_filter_chrm.nf
- Changes to output text from samtools/samtools_final_calc_frip.nf
- Changes to output formatting for samtools/samtools_quality_checks.nf
- Updated snpEff container to v5.1d to support GRCm39
- Changes to output fields for mouse and human from snpeff_snpsift/snpsift_extractfields.nf
- Added missing container to utility_modules/concatenate_reads_PE.nf and utility_modules/concatenate_reads_SE.nf
v0.2.2
Release 0.2.2
- Change WES and WGS COMSIC annotation to use SNPsift.
- Added explicit dbSNP annotation.
Pipelines Added:
NONE
Modules Added:
- SNPSIFT_ANNOTATE
Pipeline Changes:
- WES and WGS now use SNPSift to annotate COSMIC and dbSNP IDs onto variants.
Module Changes:
- COSMIC_ANNOTATION and associated perl scripts removed.
v0.2.1
RELEASE NOTES
Release 0.2.1
Added STAR support to RNA-seq pipeline.
Pipelines Added:
NONE
Modules Added:
NONE
Pipeline Changes:
- RNA-seq pipeline now supports STAR and bowtie2 (default) through the RSEM module.
Module Changes:
- RSEM: --rsem_aligner accepts "bowtie2" or "star." The default STAR indices for mouse and human are 100 bp, with alternates suggested in the RNA-seq config file.
Release 0.2.0
NOTE: This release contains a patch for multi-sample processing. We strongly recommend multi-sample processing done prior to this release should be re-run with v0.2.0+
Pipelines Added:
- RRBS - Mouse & Human
- ATAC - Mouse & Human
Modules Added:
- FastQC
- Trim-Galore
- Bismark Alignment
- Bismark Deduplicator
- Bismark Methylation Extractor
- MultiQC
- Bedtools functions for ATAC QC summary
- Bowtie2
- Cutadapt
- Deeptools bamcoverage and alignmentSieve
- g2gTools chain convert
- Macs2 ATAC peak calling and ATAC peak coverage
- Subread feature counts
Pipeline Changes:
- Multiple pipeline changes related to multi-sample patch.
- Modified module load statements to invoke "${projectDir}" instead of relative "../" path.
- Removed CTP and Probe coverage calculations from human RNA-seq
Module Changes:
- Multiple module changes related to multi-sample patch.
- Trimmomatic Trim stub module removed.
- RSEM - forward stranded option added.
- Picard Collect RNAseqMetrics - forward strand option added.
Release 0.1.2
Updated run scripts to load CS supported Nextflow module.
Release 0.1.1
Pipelines Added:
NONE
Modules Added:
- concatenate_reads_PE.nf
- concatenate_reads_SE.nf
- Modules refactored to individual files (e.g., gatk_haplotypecaller.nf).
Pipeline Changes:
- Added ability to concatenate Fastq files by sample, which are split across sequencing lanes into single R1/R2 or R1 files (depending on PE or SE).
- Adjusted pipelines for refactored module files.
- Fixed CTP/PROBE typo in human RNA coverage calculation.
- Added HPC
--profile
options and settings for Sumner and Elion.
Module Changes:
- Adjusted WGS wall clock settings.
- Refactored modules to individual files (e.g., gatk_haplotypecaller.nf).
- Set pipeline script parameter to hard coded paths.
- Cleaned all Nextflow files from the bin directory.
- Removed Sumner specific HPC settings from each module.
Release 0.1.0 -- 03.28.2022
Pipelines Added:
- Whole Genome Sequencing - Mouse & Human
- Whole Exome Sequencing - Mouse & Human
- RNA Sequencing - Mouse & Human
Modules Added:
- bamtools.nf
- bcftools.nf
- bwa.nf
- cosmic.nf
- gatk.nf
- picard.nf
- quality_stats.nf
- read_groups.nf
- rsem.nf
- samtools.nf
- snpeff.nf
- snpsift.nf
- summary_stats.nf
- trimmomatic.nf
Pipeline Changes:
NONE
Module Changes:
NONE
v0.2.0
RELEASE NOTES
Release 0.2.0
NOTE: This release contains a patch for multi-sample processing. We strongly recommend multi-sample processing done prior to this release should be re-run with v0.2.0+
Pipelines Added:
- RRBS - Mouse & Human
- ATAC - Mouse & Human
Modules Added:
- FastQC
- Trim-Galore
- Bismark Alignment
- Bismark Deduplicator
- Bismark Methylation Extractor
- MultiQC
- Bedtools functions for ATAC QC summary
- Bowtie2
- Cutadapt
- Deeptools bamcoverage and alignmentSieve
- g2gTools chain convert
- Macs2 ATAC peak calling and ATAC peak coverage
- Subread feature counts
Pipeline Changes:
- Multiple pipeline changes related to multi-sample patch.
- Modified module load statements to invoke "${projectDir}" instead of relative "../" path.
- Removed CTP and Probe coverage calculations from human RNA-seq
Module Changes:
- Multiple module changes related to multi-sample patch.
- Trimmomatic Trim stub module removed.
- RSEM - forward stranded option added.
- Picard Collect RNAseqMetrics - forward strand option added.
Release 0.1.2
Updated run scripts to load CS supported Nextflow module.
Release 0.1.1
Pipelines Added:
NONE
Modules Added:
- concatenate_reads_PE.nf
- concatenate_reads_SE.nf
- Modules refactored to individual files (e.g., gatk_haplotypecaller.nf).
Pipeline Changes:
- Added ability to concatenate Fastq files by sample, which are split across sequencing lanes into single R1/R2 or R1 files (depending on PE or SE).
- Adjusted pipelines for refactored module files.
- Fixed CTP/PROBE typo in human RNA coverage calculation.
- Added HPC
--profile
options and settings for Sumner and Elion.
Module Changes:
- Adjusted WGS wall clock settings.
- Refactored modules to individual files (e.g., gatk_haplotypecaller.nf).
- Set pipeline script parameter to hard coded paths.
- Cleaned all Nextflow files from the bin directory.
- Removed Sumner specific HPC settings from each module.
Release 0.1.0 -- 03.28.2022
Pipelines Added:
- Whole Genome Sequencing - Mouse & Human
- Whole Exome Sequencing - Mouse & Human
- RNA Sequencing - Mouse & Human
Modules Added:
- bamtools.nf
- bcftools.nf
- bwa.nf
- cosmic.nf
- gatk.nf
- picard.nf
- quality_stats.nf
- read_groups.nf
- rsem.nf
- samtools.nf
- snpeff.nf
- snpsift.nf
- summary_stats.nf
- trimmomatic.nf
Pipeline Changes:
NONE
Module Changes:
NONE