Skip to content

Fix #522: Protocol processing for cellrangermulti#524

Merged
tgelafr-pfzr merged 3 commits intonf-core:devfrom
tgelafr-pfzr:bug/523-protocol-cellrangermulti
Feb 25, 2026
Merged

Fix #522: Protocol processing for cellrangermulti#524
tgelafr-pfzr merged 3 commits intonf-core:devfrom
tgelafr-pfzr:bug/523-protocol-cellrangermulti

Conversation

@tgelafr-pfzr
Copy link

@tgelafr-pfzr tgelafr-pfzr commented Feb 24, 2026

Previously, the protocol parameter was not being passed to the cellranger multi call, so the value was always treated as auto. I pass it correctly.

PR checklist

  • This comment contains a description of changes (with reason).
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • CHANGELOG.md is updated.

@tgelafr-pfzr tgelafr-pfzr requested a review from Copilot February 24, 2026 14:47
@nf-core-bot
Copy link
Member

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 3.5.1.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation.

Copy link

Copilot AI left a 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 pull request fixes issue #522 where the protocol/chemistry parameter was not being passed to cellranger multi. The fix adds the protocol configuration to the GEX options metadata, following the same pattern used by the non-multi cellranger aligner.

Changes:

  • Add protocol/chemistry configuration to cellrangermulti GEX options
  • Update CHANGELOG to document the fix

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
workflows/scrnaseq.nf Adds chemistry option from protocol_config['protocol'] to the GEX metadata options for cellrangermulti
CHANGELOG.md Documents the fix for issue #522 in the changelog

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tgelafr-pfzr tgelafr-pfzr self-assigned this Feb 24, 2026
@tgelafr-pfzr tgelafr-pfzr added the bug Something isn't working label Feb 24, 2026
@fmalmeida
Copy link
Contributor

Changes look really clean, so would be fine.
Just want to know why is needed. In cellranger multi the chemistry meta is what is used for processing?

@tgelafr-pfzr
Copy link
Author

Changes look really clean, so would be fine. Just want to know why is needed. In cellranger multi the chemistry meta is what is used for processing?

Typically defaults to auto-detection of the chemistry based on barcodes, but you can manually specify in the cellranger call: https://www.10xgenomics.com/support/software/cell-ranger/latest/advanced/cr-multi-config-csv-opts#chem-opts

Just came up for my team with some (very) low quality data for which the barcodes were difficult to resolve. A rare use case but this will allow a better mirroring of the cellranger functionality.

@fmalmeida
Copy link
Contributor

fmalmeida commented Feb 24, 2026

So it needs to be conditionally put as well no?

So by default keeps the auto detection but in case it is manually given then it adds?

Or this config protocol variable already works conditionally like that?

@tgelafr-pfzr
Copy link
Author

If it's set to "auto" (which is the default for both cellranger and this pipeline), it still auto-detects the chemistry, same as if it were excluded. So I think it's fine to always set it. This mirrors the behavior for the CELLRANGER_COUNT setup: https://github.com/nf-core/scrnaseq/blob/f7bf36d7c7e4bddc5302c3facd8d19ca83e22226/subworkflows/local/align_cellranger.nf#L38C1-L39C1.

@tgelafr-pfzr tgelafr-pfzr merged commit 1f657d0 into nf-core:dev Feb 25, 2026
21 checks passed
@tgelafr-pfzr tgelafr-pfzr deleted the bug/523-protocol-cellrangermulti branch February 25, 2026 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants