Skip to content

Add a new module - gridss/extractoverlappingfragments - #12450

Open
imsarath wants to merge 6 commits into
nf-core:masterfrom
imsarath:gridss_extract_overlapping_fragments
Open

Add a new module - gridss/extractoverlappingfragments#12450
imsarath wants to merge 6 commits into
nf-core:masterfrom
imsarath:gridss_extract_overlapping_fragments

Conversation

@imsarath

@imsarath imsarath commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

This PR adds a module for gridss/extractoverlappingfragments; It extracts all alignments for read pairs with at least one alignment overlapping a set of regions of interest (including mate reads and supplementary alignments). This script is part of the GRIDSS toolkit and is primarily used to extract reads of interest for targeted GRIDSS structural variant calling. Github - PapenfussLab/gridss; The script is bundled within the main gridss installation

PR checklist

Closes #12422

  • 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

@imsarath
imsarath marked this pull request as draft July 28, 2026 12:19
Comment thread modules/nf-core/gridss/extractoverlappingfragments/tests/main.nf.test Outdated
Comment thread modules/nf-core/gridss/extractoverlappingfragments/main.nf Outdated
Comment thread modules/nf-core/gridss/extractoverlappingfragments/main.nf Outdated
Comment thread modules/nf-core/gridss/extractoverlappingfragments/main.nf Outdated
Comment thread modules/nf-core/gridss/extractoverlappingfragments/main.nf Outdated
Comment thread modules/nf-core/gridss/extractoverlappingfragments/main.nf Outdated
Comment thread modules/nf-core/gridss/extractoverlappingfragments/main.nf Outdated
Comment thread modules/nf-core/gridss/extractoverlappingfragments/main.nf Outdated
Comment thread modules/nf-core/gridss/extractoverlappingfragments/main.nf Outdated
output:
tuple val(meta), path("*.subset.bam"), emit: bam
tuple val("${task.process}"), val('gridss'), eval("CallVariants --version 2>&1 | sed 's/-gridss//'"), topic: versions, emit: versions_gridss

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.

Please add the disambiguation check to ensure that the input and output bams don't have the same name.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, sure. Added the disambiguation check. Thanks for the review 👍

@imsarath imsarath self-assigned this Jul 29, 2026
@imsarath
imsarath marked this pull request as ready for review July 29, 2026 13:38
imsarath and others added 2 commits July 29, 2026 15:42
Co-authored-by: Simon Pearce <24893913+SPPearce@users.noreply.github.com>
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.

new module: gridss/extract_overlapping_fragments

2 participants