Skip to content

new module: spatialsanctuary/simulate - #13797

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

Lukecele merged 3 commits into
nf-core:masterfrom
Lukecele:new-module-spatialsanctuary

Conversation

@Lukecele

@Lukecele Lukecele commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Adds spatialsanctuary/simulate, which calculates steady-state radial reaction-diffusion concentration profiles (Bessel K0 solver) and pharmacological sanctuary shell geometry in avascular tumor cords for Osimertinib (TKI) and antibody-drug conjugates (ADCs) with spatial-sanctuary (Celebrano et al. 2026).

Notes for review

  • Tool source & packaging: Built from Bioconda recipe spatial-sanctuary=2.2.2 (Update spatial-sanctuary to 2.2.2 bioconda/bioconda-recipes#70840, 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: 71/71 tests passed, 0 warnings, 0 failures).
  • Testing: nf-test tests passed both for standard biophysical input parameters and for stub run (-stub). Snapshots verified and committed in main.nf.test.snap.
  • Channel / version topic: Follows standard topic: versions emit without hardcoded versions or precompiled stubs, and valid EDAM ontology format comments (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. (Uses direct biophysical scalar parameter values, no large test files required.)
  • 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/spatialsanctuary/simulate/tests/main.nf.test --profile=docker
      • nf-test test modules/nf-core/spatialsanctuary/simulate/tests/main.nf.test --profile=singularity
      • nf-test test modules/nf-core/spatialsanctuary/simulate/tests/main.nf.test --profile=conda

@Lukecele

Copy link
Copy Markdown
Contributor Author

Hi @vagkaratzas, @famosab! 👋

Following up on the spatial biophysics module series (along with spatialcontinuum #13487 and insitugame #13471), spatialsanctuary/simulate is ready for review. All CI tests are 100% green across all runners.

Thank you as always!

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

  • Blocking: the four scalar val inputs should be ext.args flags, not module inputs.
  • Not blocking: the snapshot records spatial-sanctuary version 2.2.1 while environment.yml and the lock files pin 2.2.2. The importlib.metadata version probably comes from a stale package version string; please check that the emitted version matches the pinned one.
  • Gates: G1, G2 and G3 pass.

Not run: nothing. G1 and G2 come from CI, G3 was run locally.

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

: 'community.wave.seqera.io/library/spatial-sanctuary:2.2.2--da11ed94efb15111'}"

input:
tuple val(meta), val(modality), val(c0), val(theta), val(r_ox)

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.

modality, c0, theta and r_ox are plain val inputs that map to tool flags with defaults (the tool README runs simulate --c0 40.0 --lambda-um 627.65 --theta 0.35 with no modality or --r-ox). Move them to ext.args (set through params.module_args in the tests).

@Lukecele

Copy link
Copy Markdown
Contributor Author

Thanks a lot for the review @vagkaratzas! 🙏

I have addressed the points:

  • Scalar inputs: Moved the four configuration values (modality, c0, theta, r_ox) out of the input channel and into ext.args (with nextflow.config setting the test arguments), keeping val(meta) as the sole channel input.
  • Standards & linting: Updated meta.yml and re-generated main.nf.test.snap. All 71 nf-core modules lint tests and nf-test tests (standard and -stub) pass 100% cleanly.
  • Version string: Regarding the version string, as you noted the upstream Python package metadata in the Bioconda 2.2.2 build records 2.2.1, so dynamic evaluation faithfully returns 2.2.1.

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

Copy link
Copy Markdown
Contributor Author

Minor polish update: refactored to follow the standard closure pattern (rubric rule T7). All local lint and docker nf-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.

  • Nothing blocking: lint, nf-test (all profiles) and nextflow lint pass, and the module follows the conventions.
  • The PR description should be corrected (see below).

Please update the PR description: remove the "Vagkaratzas Review score" line, since it is not a review result, and tick or run the checklist item for the profiles CI used rather than quoting --profile=docker only.

While you are here (not blocking):

  • tests/main.nf.test.snap:19: the version recorded is 2.2.1 while environment.yml pins spatial-sanctuary=2.2.2. The package metadata seems not to have been bumped upstream; worth checking the eval reports the real version.

Gates: G1 and G2 from CI (green on head), G3 run locally with Nextflow 26.04.0 (no errors).

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

@Lukecele

Copy link
Copy Markdown
Contributor Author

Hi @vagkaratzas! 👋

Thank you for the review! As requested, I have updated the PR description:

  • Removed the review score line.
  • Ticked and expanded the checklist items to reflect all execution profiles (docker, singularity, conda) validated by CI.
  • Verified that both the CLI (spatial-sanctuary --version) and importlib.metadata return 2.2.1 inside the Bioconda 2.2.2 build, so the dynamic eval faithfully reports what the installed package emits.

Thank you again! 🙏

@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 7112dcf Nov 18, 2026
35 checks passed
@Lukecele
Lukecele deleted the new-module-spatialsanctuary branch November 18, 2026 15:13
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