Skip to content

Add new module: saltshaker/classify#10914

Merged
ieduba merged 22 commits intonf-core:masterfrom
ieduba:saltshaker_classify
Mar 17, 2026
Merged

Add new module: saltshaker/classify#10914
ieduba merged 22 commits intonf-core:masterfrom
ieduba:saltshaker_classify

Conversation

@ieduba
Copy link
Contributor

@ieduba ieduba commented Mar 16, 2026

PR checklist

Add new module saltshaker/classify to build on the recently added module saltshaker/call. Together they perform downstream calling and classification of mitochondrial SVs from the mitosalt tool.

  • 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

Copy link
Contributor

@fellen31 fellen31 left a comment

Choose a reason for hiding this comment

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

Nice!

type: file
description: tsv with classified call metadata to be used in saltshaker_plot
pattern: "*_classify_metadata.tsv"
ontologies: []
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there are ontologies for these.

type: file
description: txt file with case classification
pattern: "*_classify.txt"
ontologies: []
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there are ontologies for these.

type: file
description: vcf file with classified calls
pattern: "*saltshaker.vcf"
ontologies: []
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there are ontologies for these.

"""
echo $args

touch ${prefix}.saltshaker.vcf
Copy link
Contributor

Choose a reason for hiding this comment

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

Touch this only when --vcf is in args.

Copy link
Contributor

@fellen31 fellen31 left a comment

Choose a reason for hiding this comment

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

Nice! LGTM!

@ieduba ieduba enabled auto-merge March 17, 2026 10:32
@ieduba ieduba added this pull request to the merge queue Mar 17, 2026
Merged via the queue into nf-core:master with commit 659c65b Mar 17, 2026
28 checks passed
@ieduba ieduba deleted the saltshaker_classify branch March 17, 2026 10:36
ctuni pushed a commit to ctuni/modules that referenced this pull request Mar 17, 2026
* add saltshaker classify module and tests

* pin pip version

* add saltshaker classify module and tests

* pin pip version

* update test with nf-core saltshaker/call

* fix linting

* add saltshaker classify module and tests

* pin pip version

* update test with nf-core saltshaker/call

* fix linting

* edits from review

* update snaps and meta.yml

* only make vcf in stub if vcf is in args

* add no-vcf tests

---------

Co-authored-by: Irene Duba <irene.duba@scilifelab.se>
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