Skip to content

Add parameter glimpse version - #308

Open
LouisLeNezet wants to merge 7 commits into
nf-core:devfrom
LouisLeNezet:chunk_version
Open

Add parameter glimpse version#308
LouisLeNezet wants to merge 7 commits into
nf-core:devfrom
LouisLeNezet:chunk_version

Conversation

@LouisLeNezet

Copy link
Copy Markdown
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
  • If necessary, also make a PR on the nf-core/phaseimpute branch on the nf-core/test-datasets repository.
  • 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).

@LouisLeNezet LouisLeNezet self-assigned this Sep 2, 2026
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 4.0.3.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the Synchronisation documentation.

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅

Posted for pipeline commit 535852e

+| ✅ 216 tests passed       |+
#| ❔   2 tests were ignored |#
#| ❔   1 tests had warnings |#
Details

❔ Tests ignored:

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.3
  • Run at 2026-09-03 12:57:47

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

❌ nf-test failed with latest Nextflow version

Note

Tests with Nextflow's latest version failed but it will not cause a CI workflow failure.
Please check if the failure is expected with newer (edge-)releases of Nextflow or if it needs fixing.

  • docker | latest-everything | Shard 7/7

See the full run for details.

@LouisLeNezet
LouisLeNezet marked this pull request as ready for review September 3, 2026 12:28

@atrigila atrigila left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nice work! Just some comments

Comment thread conf/test_full.config
normalize = true
compute_freq = false
phase = false
chunk_version = "V2"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can you update usage.md to document these new changes, please? Thank you :)

Comment thread main.nf
compute_freq : params.compute_freq,
phase : params.phase,
chunk_model : params.chunk_model
chunk_model : params.chunk_model,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Chunk model won't apply to both v1 and v2, right? Should we have a warning if you provide a v2 model and request a v1 version?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Maybe a test case can be added to cover for this scenario as well

GLIMPSE2_CHUNK(ch_input_glimpse2, chunk_model)
ch_chunks = GLIMPSE2_CHUNK.out.chunk_chr
} else {
error ("Parameter chunk_version should be V1 or V2, found: ${chunk_version}.")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think this is not needed since it should fail before this if a different one is provided. It should fail and error due to the schema which only allows enums.

if (row.size() == 8) {
return [ meta, row[3], row[2] ] // header is 'ID', 'Chr', 'RegionBuff', 'RegionCnk', 'WindowCm', 'WindowMb', 'NbTotVariants', 'NbComVariants'
}
error "Chunks csv should have either 6 columns (glimpse V1 format) or 8 columns (glimpse V2 format)"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This should also be documented in usage.md

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.

2 participants