Skip to content

New module for mergestr#12015

Merged
KondratievaOlesya merged 7 commits into
nf-core:masterfrom
KondratievaOlesya:trtools_mergestr
Jul 2, 2026
Merged

New module for mergestr#12015
KondratievaOlesya merged 7 commits into
nf-core:masterfrom
KondratievaOlesya:trtools_mergestr

Conversation

@KondratievaOlesya

Copy link
Copy Markdown
Contributor

This PR adds a new nf-core module for mergeSTR from the TRTools package.

PR checklist

Closes #12014

  • 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 module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Broadcast software version numbers to topic: versions - See version_topics
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • For modules:
      • nf-core modules test <MODULE> --profile docker
      • nf-core modules test <MODULE> --profile singularity
      • nf-core modules test <MODULE> --profile conda
    • For subworkflows:
      • nf-core subworkflows test <SUBWORKFLOW> --profile docker
      • nf-core subworkflows test <SUBWORKFLOW> --profile singularity
      • nf-core subworkflows test <SUBWORKFLOW> --profile conda

Copilot AI review requested due to automatic review settings June 16, 2026 12:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 new nf-core DSL2 module wrapping mergeSTR (TRTools) to merge multiple TR-genotyper VCFs into a single merged VCF, along with nf-test coverage.

Changes:

  • Added trtools/mergestr module implementation (process, container/conda, outputs + versions topic).
  • Added module metadata (meta.yml) and conda environment definition.
  • Added nf-test tests, config overrides, and snapshots using gangstr-produced VCFs as inputs.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
modules/nf-core/trtools/mergestr/main.nf Implements the TRTOOLS_MERGESTR process, including bgzip/tabix indexing and versions emission.
modules/nf-core/trtools/mergestr/meta.yml Declares module inputs/outputs and version reporting metadata for nf-core tooling.
modules/nf-core/trtools/mergestr/environment.yml Defines the conda environment (TRTools 6.1.0).
modules/nf-core/trtools/mergestr/tests/main.nf.test Adds nf-test coverage (real + stub) for the new module.
modules/nf-core/trtools/mergestr/tests/main.nf.test.snap Stores expected outputs for nf-test runs.
modules/nf-core/trtools/mergestr/tests/nextflow.config Provides test-specific ext.args overrides for TRTOOLS_MERGESTR and the setup GANGSTR runs.

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

Comment thread modules/nf-core/trtools/mergestr/main.nf Outdated
Comment thread modules/nf-core/trtools/mergestr/main.nf Outdated
Comment thread modules/nf-core/trtools/mergestr/meta.yml Outdated
Comment thread modules/nf-core/trtools/mergestr/meta.yml Outdated

@LouisLeNezet LouisLeNezet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just a few comments but good to go otherwise

Comment thread modules/nf-core/trtools/mergestr/main.nf Outdated
Comment thread modules/nf-core/trtools/mergestr/environment.yml Outdated
Comment thread modules/nf-core/trtools/mergestr/tests/main.nf.test Outdated
Comment thread modules/nf-core/trtools/mergestr/tests/main.nf.test
Comment thread modules/nf-core/trtools/mergestr/tests/main.nf.test.snap Outdated

@LouisLeNezet LouisLeNezet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

assertAll(
{ assert process.success },
{ assert snapshot(
process.out.vcf.collect { it.collect { it instanceof Map ? it : file(it).name + ":variantsMD5," + path(it).vcf.variantsMD5 }},

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is really nice, we often just do path(process.out.vcf[0][1]).vcf.variantsMD5 but this does work.

@KondratievaOlesya KondratievaOlesya added this pull request to the merge queue Jul 2, 2026
Merged via the queue into nf-core:master with commit 96117a7 Jul 2, 2026
62 checks passed
@KondratievaOlesya KondratievaOlesya deleted the trtools_mergestr branch July 2, 2026 06:33
@KondratievaOlesya

Copy link
Copy Markdown
Contributor Author

Thank you for the review!

vagkaratzas pushed a commit that referenced this pull request Jul 2, 2026
* New module for mergestr

* Fix review

* Fix typo in stub

* Fix typo in stub

* Fix review comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

new module: trtools/mergestr

3 participants