Skip to content

new module: spatialcontinuumtranslational/gist - #13794

Merged
Lukecele merged 5 commits into
nf-core:masterfrom
Lukecele:new-module-spatialcontinuumtranslational
Nov 18, 2026
Merged

Lukecele merged 5 commits into
nf-core:masterfrom
Lukecele:new-module-spatialcontinuumtranslational

Conversation

@Lukecele

@Lukecele Lukecele commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Adds spatialcontinuumtranslational/gist, which calculates deterministic, research-only Gastrointestinal Stromal Tumor (GIST) phenotype profiles and risk stratification from cohort TSV, CSV, or JSON data with spatial-continuum-translational (Celebrano et al. 2026).

Notes for review

  • Tool source & packaging: Built from Bioconda recipe spatial-continuum-translational=0.1.53 (Add spatial-continuum-translational bioconda/bioconda-recipes#71345, merged). Multi-architecture Wave container images (amd64/arm64) and lockfiles in .conda-lock/ were generated with nf-core modules containers create.
  • Standards & linting: Fully compliant with nf-core tools 4.1.0/4.2.2 (nf-core modules lint: 74/74 tests passed, 0 warnings, 0 failures).
  • Testing: nf-test tests verify standard cohort inputs across TSV, CSV, and JSON, exercising both default JSON and --format tsv output branches, as well as stub run (-stub). Snapshots verified in main.nf.test.snap.
  • Channel / version topic: Follows standard topic: versions emit without hardcoded versions or precompiled stubs, and valid EDAM ontologies (format_3475 # TSV, format_3752 # CSV, format_3464 # JSON).
  • Scope: Research Use Only (RUO).

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 module conventions in the contribution docs
  • If necessary, include test data in your PR. (Generates isolated inline TSV/CSV/JSON test data via Groovy file creation.)
  • 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:
    • For modules:
      • nf-test test modules/nf-core/spatialcontinuumtranslational/gist/tests/main.nf.test --profile=docker
      • nf-test test modules/nf-core/spatialcontinuumtranslational/gist/tests/main.nf.test --profile=singularity
      • nf-test test modules/nf-core/spatialcontinuumtranslational/gist/tests/main.nf.test --profile=conda

@Lukecele

Copy link
Copy Markdown
Contributor Author

Hi @vagkaratzas, @famosab! 👋

Whenever you have a chance, spatialcontinuumtranslational/gist is fully configured and ready for review. All CI matrix checks are 100% green with dynamic topic: versions and multi-arch Seqera Wave containers.

Thanks a lot!

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

  • Please add test coverage for the --format tsv output branch and the other input formats (CSV, JSON); the tsv output is currently never exercised.
  • Use ${prefix}-based output paths instead of globs, and make the format detection robust.
  • Mark optional outputs as "Optional" in meta.yml, and trim the PR body (the self-reported review score is not needed; tick/adjust the conda/singularity boxes to match what CI ran).

Gates: G1 and G2 from CI (all lint and nf-test jobs green on conda, docker, singularity), G3 (nextflow lint) run locally, no errors.

Diff 8.93/10 · Overall 8.93/10
nf-core-reviewer 0.8.0dev / vagkaratzas-review (rubric v7) · claude-sonnet-5-5

Comment on lines +17 to +18
tuple val(meta), path("*_gist.json"), emit: json, optional: true
tuple val(meta), path("*_gist.tsv"), emit: tsv, optional: true

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.

The output names are predictable from ${prefix} and the format, so use them instead of globs, e.g. path("${prefix}_gist.json"). Note args.contains('--format tsv') misses --format=tsv or extra spaces, which would write TSV content into a .json file; consider a more robust check

tag "spatialcontinuumtranslational"
tag "spatialcontinuumtranslational/gist"

test("homosapiens - tsv - json") {

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.

Only the JSON-default path is covered. Add a test with params { module_args = '--format tsv' } (this needs a tests/nextflow.config with ext.args = { params.module_args ?: '' }) and ideally CSV and JSON inputs, so each branch can fail when removed

e.g. `[ id:'sample1' ]`
- "*_gist.json":
type: file
description: GIST phenotype research profile score in JSON format

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.

Both outputs are optional: true, so the descriptions should start with "Optional", here and at line 56

@Lukecele

Copy link
Copy Markdown
Contributor Author

Thanks a lot for the review @vagkaratzas! 🙏

I have addressed all points:

  • Test coverage: Added comprehensive test coverage in main.nf.test exercising the --format tsv output branch as well as CSV and JSON input formats alongside the default TSV/JSON run and stub test (all 4 tests passing in main.nf.test.snap).
  • Prefix output paths & format detection: Replaced wildcard globs with ${prefix}-based output paths (${prefix}_gist.json, ${prefix}_gist.tsv) and made the CLI format flag detection robust against whitespace and syntax variants (--format tsv, --format=tsv, -f).
  • Meta & PR body: Marked optional outputs as (Optional) in meta.yml, and trimmed the PR description body.

@Lukecele
Lukecele requested a review from vagkaratzas November 18, 2026 09:31
@Lukecele

Copy link
Copy Markdown
Contributor Author

Minor polish update: refactored to use (rubric rule T7) and updated input covariates on the JSON test to ensure distinct snapshot entries across formats (rubric rule T10). All 4 tests passing cleanly.

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

  • No blocking issues found: lint, nf-test (CI) and strict nextflow lint all pass, and the module follows the current conventions.
  • Optional: the README lists the tool on bio.tools (spatial-continuum-translational), so identifier in meta.yml could be biotools:spatial-continuum-translational instead of "".
  • Optional: the output extension is derived by regex-parsing ext.args for --format/-f, which is a little fragile; it works for the tested cases, so fine to keep.

Approval should be on its way soon.

Diff 10.00/10 · Overall 10.00/10
nf-core-reviewer 0.8.0dev / vagkaratzas-review (rubric v7) · claude-sonnet-5-5

@Lukecele

Copy link
Copy Markdown
Contributor Author

Hi @vagkaratzas! 👋

Applied the optional suggestion: added identifier: "biotools:spatial-continuum-translational" in meta.yml. Lint now passes 76/76 (0 warnings, 0 failures).

Ready for approval whenever convenient — thank you! 🙏

@Lukecele
Lukecele requested a review from vagkaratzas November 18, 2026 15:44
@Lukecele
Lukecele added this pull request to the merge queue Nov 18, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Nov 18, 2026
@Lukecele
Lukecele added this pull request to the merge queue Nov 18, 2026
Merged via the queue into nf-core:master with commit e2bbfd5 Nov 18, 2026
28 checks passed
@Lukecele
Lukecele deleted the new-module-spatialcontinuumtranslational branch November 18, 2026 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants