Template#103
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR appears to be an accidental template reset that has reverted the pipeline to its initial nf-core template state, effectively removing all functional pipeline code. The title "Template" and the removal of nearly all working code suggests this is not an intentional update but rather a mistaken commit or merge.
- The entire core workflow logic has been stripped from
workflows/lrsomatic.nf, removing all analysis steps - Input schema has been changed from BAM files to FASTQ files, incompatible with the pipeline's purpose
- All pipeline-specific parameters have been removed from configuration files
- Nearly all nf-core modules except MultiQC have been removed from the pipeline
Reviewed Changes
Copilot reviewed 44 out of 45 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| workflows/lrsomatic.nf | Removed all core pipeline functionality (alignment, variant calling, phasing, QC), leaving only MultiQC |
| assets/schema_input.json | Changed input schema from BAM files (bam_tumor, bam_normal, platform, sex, fiber) to FASTQ files (fastq_1, fastq_2) |
| nextflow.config | Removed all pipeline-specific parameters (VEP, minimap2, ASCAT, skip options, etc.) |
| nextflow_schema.json | Removed parameter definitions for minimap2_options, ascat_parameters, and skip_options sections |
| modules.json | Removed nearly all nf-core modules (ASCAT, ENSEMBLVEP, LONGPHASE, MINIMAP2, MOSDEPTH, SAMTOOLS, SEVERUS, etc.) |
| conf/test.config | Changed test data from lrsomatic-specific data to generic viralrecon template data |
| README.md | Replaced detailed pipeline description with generic template placeholder and changed samplesheet format |
| subworkflows/local/tumor_normal_happhase.nf | Added debug .view() statement and groupTuple(size: 2) parameter; changed ClairS output reference |
| modules/local/clairs/main.nf | Added separate outputs for indel and SNV VCFs with new flags |
| subworkflows/local/prepare_reference_files.nf | Added fallback to meta.clair3_model when basecall_model_meta is null |
| Various test and GitHub workflow files | Updated dependencies, versions, and test configurations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| skip_ascat = true | ||
| // TODO nf-core: Specify the paths to your test data on nf-core/test-datasets | ||
| // TODO nf-core: Give any required params for the test so that command line flags are not needed | ||
| input = params.pipelines_testdata_base_path + 'viralrecon/samplesheet/samplesheet_test_illumina_amplicon.csv'// Genome references |
There was a problem hiding this comment.
Missing space before inline comment. There should be a space between the path string and the comment // Genome references.
| input = params.pipelines_testdata_base_path + 'viralrecon/samplesheet/samplesheet_test_illumina_amplicon.csv'// Genome references | |
| input = params.pipelines_testdata_base_path + 'viralrecon/samplesheet/samplesheet_test_illumina_amplicon.csv' // Genome references |
| **IntGenomicsLab/lrsomatic** is a bioinformatics pipeline that ... | ||
|
|
||
| This **end-to-end pipeline** handles the entire workflow — **from raw read processing and alignment, to comprehensive somatic variant calling**, including single nucleotide variants, indels, structural variants, copy number alterations, and modified bases. | ||
|
|
||
| It can be run in both **matched tumour-normal** and **tumour-only mode**, offering flexibility depending on the users study design. | ||
|
|
||
| Developed using **Nextflow DSL2**, it offers high portability and scalability across diverse computing environments. By leveraging Docker or Singularity containers, installation is streamlined and results are highly reproducible. Each process runs in an isolated container, simplifying dependency management and updates. Where applicable, pipeline components are sourced from **nf-core/modules**, promoting reuse, interoperability, and consistency within the broader Nextflow and nf-core ecosystems. | ||
|
|
||
| ## Pipeline summary | ||
|
|
||
| **1) Pre-processing:** | ||
|
|
||
| a. Raw read QC ([`cramino`](https://github.com/wdecoster/cramino)) | ||
|
|
||
| b. Alignment to the reference genome ([`minimap2`](https://github.com/lh3/minimap2)) | ||
|
|
||
| c. Post alignment QC ([`cramino`](https://github.com/wdecoster/cramino), [`samtools idxstats`](https://github.com/samtools/samtools), [`samtools flagstats`](https://github.com/samtools/samtools), [`samtools stats`](https://github.com/samtools/samtools)) | ||
|
|
||
| d. Specific for calling modified base calling ([`Modkit`](https://github.com/nanoporetech/modkit), [`Fibertools`](https://github.com/fiberseq/fibertools-rs)) | ||
|
|
||
| **2i) Matched mode: small variant calling:** | ||
|
|
||
| a. Calling Germline SNPs ([`Clair3`](https://github.com/HKU-BAL/Clair3)) | ||
|
|
||
| b. Phasing and Haplotagging the SNPs in the normal and tumour BAM ([`LongPhase`](https://github.com/twolinin/longphase)) | ||
|
|
||
| c. Calling somatic SNVs ([`ClairS`](https://github.com/HKU-BAL/ClairS)) | ||
|
|
||
| **2ii) Tumour only mode: small variant calling:** | ||
|
|
||
| a. Calling Germline SNPs and somatic SNVs ([`ClairS-TO`](https://github.com/HKU-BAL/ClairS-TO)) | ||
|
|
||
| b. Phasing and Haplotagging germline SNPs in tumour BAM ([`LongPhase`](https://github.com/twolinin/longphase)) | ||
|
|
||
| **3) Large variant calling:** | ||
|
|
||
| a. Somatic structural variant calling ([`Severus`](https://github.com/KolmogorovLab/Severus)) | ||
|
|
||
| b. Copy number alterion calling; long read version of ([`ASCAT`](https://github.com/VanLoo-lab/ascat)) | ||
| <!-- TODO nf-core: | ||
| Complete this sentence with a 2-3 sentence summary of what types of data the pipeline ingests, a brief overview of the | ||
| major pipeline sections and the types of output it produces. You're giving an overview to someone new | ||
| to nf-core here, in 15-20 seconds. For an example, see https://github.com/nf-core/rnaseq/blob/master/README.md#introduction | ||
| --> |
There was a problem hiding this comment.
The README description has been replaced with a generic template placeholder ("IntGenomicsLab/lrsomatic is a bioinformatics pipeline that ..."). The original comprehensive description of the pipeline's purpose, features, and capabilities has been removed, leaving users without proper documentation of what the pipeline does.
|
ljwharbers
left a comment
There was a problem hiding this comment.
ascat, minimap2, and samtools-stats diff files no longer needed or?
| - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
There was a problem hiding this comment.
I put this in manually before since otherwise sometimes the CIs crash because of no disk space.
There was a problem hiding this comment.
All these should be reverted as well I think @robert-a-forsyth
|
@robert-a-forsyth I've opened a new pull request, #104, to work on those changes. Once the pull request is ready, I'll request review from you. |
ljwharbers
left a comment
There was a problem hiding this comment.
Looks good to me after all tests pass
PR checklist
nf-core pipelines lint).nextflow run . -profile test,docker --outdir <OUTDIR>).nextflow run . -profile debug,test,docker --outdir <OUTDIR>).docs/usage.mdis updated.docs/output.mdis updated.CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).