Skip to content

Whatshap stats#147

Merged
robert-a-forsyth merged 10 commits intodevfrom
whatshap_stats
Mar 17, 2026
Merged

Whatshap stats#147
robert-a-forsyth merged 10 commits intodevfrom
whatshap_stats

Conversation

@ljwharbers
Copy link
Collaborator

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

Copilot AI review requested due to automatic review settings March 13, 2026 16:02
@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2026

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 65edddc

+| ✅ 178 tests passed       |+
#| ❔  21 tests were ignored |#
#| ❔   1 tests had warnings |#
!| ❗  28 tests had warnings |!
Details

❗ Test warnings:

  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in lint_log.txt: Named file extensions MUST be emitted for ALL output channels
  • pipeline_todos - TODO string in lint_log.txt: List additional required output channels/values here
  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • pipeline_todos - TODO string in nextflow.config: Update the field with the details of the contributors to your pipeline. New with Nextflow version 24.10.0
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • pipeline_todos - TODO string in meta.yml: #Add a description of the module and list keywords
  • local_component_structure - tumor_only_happhase.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_annotation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - tumor_normal_happhase.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - prepare_reference_files.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

  • files_exist - File is ignored: CODE_OF_CONDUCT.md
  • files_exist - File is ignored: assets/nf-core-lrsomatic_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-lrsomatic_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-lrsomatic_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/config.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • files_unchanged - File ignored due to lint config: CODE_OF_CONDUCT.md
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_unchanged - File does not exist: .github/ISSUE_TEMPLATE/config.yml
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: assets/email_template.txt
  • files_unchanged - File ignored due to lint config: assets/nf-core-lrsomatic_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-lrsomatic_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-lrsomatic_logo_dark.png
  • files_unchanged - File ignored due to lint config: docs/README.md
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/lrsomatic/lrsomatic/.github/workflows/awstest.yml
  • schema_params - schema_params

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-03-13 17:10:17

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a WhatsHap stats QC step to the lrsomatic workflow (with a skip flag) and wires the resulting TSV into MultiQC. The PR also includes additional nf-core module content for DeepVariant (modules + nf-test configs/snapshots).

Changes:

  • Integrate WHATSHAP_STATS into workflow LRSOMATIC, collecting outputs into MultiQC and adding skip_whatshapstats.
  • Update tumor-only and tumor/normal happhase subworkflows to use LONGPHASE_PHASE.out.snv_vcf for the germline VEP channel.
  • Add nf-core modules/tests for whatshap/stats and DeepVariant (makeexamples, callvariants, postprocessvariants) plus modules.json updates.

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
workflows/lrsomatic.nf Imports and conditionally runs WHATSHAP_STATS; mixes TSV into MultiQC inputs.
subworkflows/local/tumor_only_happhase.nf Switches germline VEP input to phased VCF from LongPhase.
subworkflows/local/tumor_normal_happhase.nf Switches germline VEP input to phased VCF from LongPhase (comment now slightly outdated).
nextflow.config Adds default params.skip_whatshapstats.
nextflow_schema.json Adds schema entry for skip_whatshapstats.
conf/modules.config Adds publishDir/args/prefix defaults for WHATSHAP_STATS; also adds --sample_name args for Clair modules.
modules/nf-core/whatshap/stats/* New nf-core-style module + metadata + tests for WhatsHap stats.
modules/nf-core/deepvariant/* (+ tests) Adds DeepVariant modules and nf-test scaffolding/snapshots.
modules.json Records installed nf-core modules including whatshap/stats (and nanoplot entry update).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

include { ENSEMBLVEP_VEP as SOMATIC_VEP } from '../modules/nf-core/ensemblvep/vep/main.nf'
include { ENSEMBLVEP_VEP as GERMLINE_VEP } from '../modules/nf-core/ensemblvep/vep/main.nf'
include { ENSEMBLVEP_VEP as SV_VEP } from '../modules/nf-core/ensemblvep/vep/main.nf'
include { WHATSHAP_STATS } from '../modules/nf-core/whatshap/stats/main'
type: boolean
description: Whether to include GTF output file
default: false
- inlude_block_output:
return [meta, vcf, extra]
}
.set { germline_vep }
// [meta, clair3_vcf, []] -- germline small variants for VEP annotation
Comment on lines +67 to +73
ontologies: []
- - meta5:
type: map
description: |
Groovy Map containing reference information
e.g. [ id:'genome' ]
pattern: "*.gzi"
type: string
description: The name of the tool
- whatshap --version:
type: string
Comment on lines +1 to +6
process DEEPVARIANT_MAKEEXAMPLES {
tag "$meta.id"
label 'process_high'

//Conda is not supported at the moment
container "docker.io/google/deepvariant:1.9.0"
- vcf:
type: file
description: Phased variant vcf file
pattern: "*.vcf"
Comment on lines +13 to +16
val(include_tsv_output) // value: [ true | false ]
val(include_gtf_output) // value: [ true | false ]
val(inlude_block_output) // value: [ true | false ]

Comment on lines +27 to +32
pattern: "*.bam/cram"
ontologies: []
- index:
type: file
description: Index of BAM/CRAM file
pattern: "*.bai/crai"
ljwharbers and others added 3 commits March 13, 2026 18:06
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@robert-a-forsyth robert-a-forsyth merged commit 6127d68 into dev Mar 17, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants