Fix #522: Protocol processing for cellrangermulti#524
Fix #522: Protocol processing for cellrangermulti#524tgelafr-pfzr merged 3 commits intonf-core:devfrom
Conversation
|
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. For more documentation on how to update your pipeline, please see the nf-core documentation and Synchronisation documentation. |
There was a problem hiding this comment.
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.
|
Changes look really clean, so would be fine. |
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. |
|
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? |
|
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 |
Previously, the
protocolparameter was not being passed to the cellranger multi call, so the value was always treated asauto. I pass it correctly.PR checklist
nf-core pipelines lint).nextflow run . -profile test,docker --outdir <OUTDIR>).nextflow run . -profile debug,test,docker --outdir <OUTDIR>).CHANGELOG.mdis updated.