Skip to content

Add velocyto from bam for cellranger - #530

Open
agalitsyna wants to merge 8 commits into
nf-core:devfrom
agalitsyna:add_velocyto_from_cellranger
Open

Add velocyto from bam for cellranger#530
agalitsyna wants to merge 8 commits into
nf-core:devfrom
agalitsyna:add_velocyto_from_cellranger

Conversation

@agalitsyna

@agalitsyna agalitsyna commented Mar 12, 2026

Copy link
Copy Markdown

This PR adds a velocyto option to Cellranger branch of the pipeline, see #525 for more discussion.
By default the parameter is disabled, and can be switched on by --run_velocyto true.

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! -- No tests are needed.
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • NA: If necessary, also make a PR on the nf-core/scrnaseq branch on the nf-core/test-datasets repository.
  • 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>).
  • Usage Documentation in docs/usage.md is updated. -- Not needed
  • Output Documentation in docs/output.md is updated. -- Not needed b/c velocyto if an option
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors). -- Nothing to be done

@nf-core-bot

Copy link
Copy Markdown
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.

@agalitsyna
agalitsyna requested a review from simroka March 20, 2026 06:33

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

Had one comment regarding parameter syntax.

Otherwise code looks sane. But, since it adds a new tool and new outputs, it would be good to have the documentation updated to showcase it

Comment thread nextflow.config
cellranger_index = null

// Velocyto parameters
run_velocyto = false

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.

I wonder if, to align more with the other parameters syntax, would make sense to change it to skip_velocyto=true.

Any options @nictru @grst?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants