Skip to content

feat!(PCGR): move sample params to samplesheet#96

Open
HomoPolyethylen wants to merge 17 commits into
nf-core:devfrom
HomoPolyethylen:feat/87_move-sample-params-to-samplesheet
Open

feat!(PCGR): move sample params to samplesheet#96
HomoPolyethylen wants to merge 17 commits into
nf-core:devfrom
HomoPolyethylen:feat/87_move-sample-params-to-samplesheet

Conversation

@HomoPolyethylen

@HomoPolyethylen HomoPolyethylen commented Jun 3, 2026

Copy link
Copy Markdown

this PR moves sample-specific parameters for PCGR to the samplesheet.
Params moved:

  • tumor_site
  • tumor_purity
  • tumor_ploidy

This is a breaking, backwards-incompatible change, as the moved params are no longer supported as pipeline parameters (via CLI or params file).

closes #87


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/variantprioritization 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).

@HomoPolyethylen HomoPolyethylen changed the title Feat!(PCGR): move sample params to samplesheet feat!(PCGR): move sample params to samplesheet Jun 3, 2026
@HomoPolyethylen HomoPolyethylen force-pushed the feat/87_move-sample-params-to-samplesheet branch from 50723aa to f1fae2c Compare June 30, 2026 18:59
@HomoPolyethylen HomoPolyethylen self-assigned this Jun 30, 2026
@HomoPolyethylen HomoPolyethylen marked this pull request as ready for review June 30, 2026 19:09
@HomoPolyethylen HomoPolyethylen requested a review from famosab June 30, 2026 19:09

@famosab famosab 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.

It looks good to me, I just have one question regarding validation of the samplesheet and handling of germline-only runs :)

Comment thread assets/schema_input.json
for samples with status: 0 (germline) columns like tumor_site have no biological meaning and should hence be rejected.
…lues

default values for optional sample-params are defined in input schema only. They not necessarily included in the tool call. PCGR will handle its default behaviour.
This change intends to prevent diversion in defaults between pipeline and pcgr in the future.
these empty dirs/files serve as dummys for tests, where the pipeline should think the reference data is present without actually using it. This can prevent the test from downloading the reference data for that test.
Comment thread modules/local/pcgr/preparevcf/main.nf Outdated
Comment thread modules/local/reformat/vcf/main.nf Outdated
test optional columns for somatic rows in one single test, each invalid field will throw an error
multiple warning ignore declarations otherwise overwrite each other. you can now specify multiple warnings to ignore as an array
@HomoPolyethylen HomoPolyethylen requested a review from famosab July 7, 2026 12:13

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.

Hm maybe we can put this into test-datasets and not have it in the pipeline directly?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

hm yes that sounds good. then I'll move the samplesheets to the test-datasets aswell?
nf-core/test-datasets#2137

Comment thread CHANGELOG.md Outdated
HomoPolyethylen added a commit to nf-core/test-datasets that referenced this pull request Jul 9, 2026
add samplesheets and dummy reference data for tests introduced in nf-core/variantprioritization#96
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.

Considering moving the sample-specific parameters to samplesheet

2 participants