Skip to content
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

feat(cellranger count and multi): Add create-bam option to cellranger count and multi pipelines #387

Open
wants to merge 6 commits into
base: dev
Choose a base branch
from

Conversation

kopichris
Copy link

This PR is related to issue #384 posted by @nick-youngblut.

The primary purpose of this pull request is to allow users to set the --create-bam parameter within the cellranger count and cellranger multi pipelines. This is an important parameter because the BAM files produced by cellranger can take up a considerable amount of disk space and computational resources, even for a small number of samples. By allowing users to set this parameter manually, we allow them finer control over how the pipeline is executed and what is provided as output.

PR checklist

  • This comment contains a description of changes (with reason).
  • Make sure your code lints (nf-core 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.

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

@kopichris
Copy link
Author

Hi @grst, anything else needed on my end before the PR can be reviewed? Thank you in advance for your time and consideration.

@grst
Copy link
Member

grst commented Oct 30, 2024

Would be great if you could look into those merge conflicts. Otherwise I'll look into it as soon as I find some time.

nextflow.config Outdated
@@ -43,6 +43,7 @@ params {
// Cellranger parameters
skip_cellranger_renaming = false
cellranger_index = null
cellranger_create_bam = true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think of unifying this into a single parameter that supports all aligners that create bams (i.e. the different cellrangers and starsolo)?

E.g. in #rnaseq this is called --save_align_intermeds

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to unify these flags into a single parameter for those aligners that create bams. I'll review the rnaseq pipeline to get a better idea about how this was implemented. Thank you again for your direction and support on this pull request.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this look 36eeee?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now is this parameter called --create-bam or --save_align_intermeds? Either is fine with me, but it should be consistent everywhere.

Other than that, this is exactly what I had in mind. Can you implement the flag also for cellranger multi and cellranger arc?

conf/modules.config Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Nov 7, 2024

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit bf1a9df

+| ✅ 217 tests passed       |+
#| ❔   4 tests were ignored |#
!| ❗   4 tests had warnings |!

❗ Test warnings:

  • pipeline_todos - TODO string in nextflow.config: Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.0.2
  • Run at 2024-11-07 13:01:42

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.

3 participants