-
Notifications
You must be signed in to change notification settings - Fork 946
Update xenium ranger modules and subworkflows #9525
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
modules/nf-core/xeniumranger/import-segmentation/tests/nextflow.config
Outdated
Show resolved
Hide resolved
subworkflows/nf-core/xeniumranger/import_segmentation_transcript/main.nf
Outdated
Show resolved
Hide resolved
4ad8abd to
72a6623
Compare
…modules and subworkflows
khersameesh24
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @an-altosian , left some comments. Would just need a small update, everything else looks good. Thanks for working on this again.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the xeniumranger modules from version 3.0.1 to 4.0 and restructures the code to follow nf-core standards. The update includes changes to all xeniumranger modules (resegment, rename, relabel, and import-segmentation) with a new Docker container approach, refactored input/output patterns, and updated test files.
- Updated xeniumranger from version 3.0.1 to 4.0.0 with a new Dockerfile that downloads the tool directly instead of requiring a local tarball
- Restructured all modules to use the new nf-core version output pattern with
eval()andtopic: versions - Simplified output structure to emit directories instead of glob patterns (
**/outs/**)
Reviewed changes
Copilot reviewed 19 out of 24 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/nf-core/xeniumranger/Dockerfile | Updated to xeniumranger 4.0.0 with wget-based download instead of COPY |
| modules/nf-core/xeniumranger/resegment/main.nf | Updated container version, simplified input/output patterns, removed parameter inputs |
| modules/nf-core/xeniumranger/resegment/meta.yml | Updated output documentation to reflect directory-based outputs |
| modules/nf-core/xeniumranger/resegment/tests/main.nf.test | Updated test inputs to use new data source and simplified assertions |
| modules/nf-core/xeniumranger/resegment/tests/main.nf.test.snap | Updated snapshots with new test data and version information |
| modules/nf-core/xeniumranger/rename/main.nf | Updated container version, consolidated input tuple, simplified output |
| modules/nf-core/xeniumranger/rename/meta.yml | Updated input/output documentation for new structure |
| modules/nf-core/xeniumranger/rename/tests/main.nf.test | Updated test inputs to match new input structure |
| modules/nf-core/xeniumranger/rename/tests/main.nf.test.snap | Updated snapshots with new test results |
| modules/nf-core/xeniumranger/relabel/main.nf | Updated container version, consolidated input tuple |
| modules/nf-core/xeniumranger/relabel/meta.yml | Updated documentation and renamed gene_panel to panel |
| modules/nf-core/xeniumranger/relabel/tests/main.nf.test | Simplified test assertions |
| modules/nf-core/xeniumranger/relabel/tests/main.nf.test.snap | Updated snapshots |
| modules/nf-core/xeniumranger/import-segmentation/main.nf | Updated container version, reordered inputs, added validation logic |
| modules/nf-core/xeniumranger/import-segmentation/meta.yml | Expanded documentation for image-based vs transcript-based modes |
| modules/nf-core/xeniumranger/import-segmentation/tests/main.nf.test | Significantly simplified tests, removed multiple test cases |
| modules/nf-core/xeniumranger/import-segmentation/tests/main.nf.test.snap | Removed most snapshots, kept only stub test snapshot |
| modules/nf-core/xeniumranger/nextflow.config | Added new config file with commented-out settings |
| modules/nf-core/xeniumranger/README.md | Removed documentation about manual Docker updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Hi @khersameesh24 , all addressed. Thank you for the comments and suggestions! |
khersameesh24
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR updates the xeniumranger version in its modules, and restructured the code to follow nf-core standard. Because xeniumranger is not on conda, I tested it using docker.
PR checklist
versions.ymlfile.labelnf-core modules test <MODULE> --profile dockernf-core modules test <MODULE> --profile singularitynf-core modules test <MODULE> --profile condanf-core subworkflows test <SUBWORKFLOW> --profile dockernf-core subworkflows test <SUBWORKFLOW> --profile singularitynf-core subworkflows test <SUBWORKFLOW> --profile conda