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

Add umicollapse as an alternative to umi-tools #1369

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

Conversation

siddharthab
Copy link

@siddharthab siddharthab commented Sep 3, 2024

Checklist:

TODO:
- [ ] Benchmark paired ends mode
- [ ] Include in multiqc
Copy link
Member

@MatthiasZepper MatthiasZepper left a comment

Choose a reason for hiding this comment

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

Excellent work, clean and well-structured! I think, you found very smart solutions to not duplicate too much of the code.

Of course, we should wait for the lead developers of the pipeline to review as well prior to merging, but in general you have my support for this addition! Ideally, your fix for umicollapse would also be included in the form of an updated tool version.

Please don't forget the Changelog later and also to add your name to the contributors (well deserved)!

nextflow_schema.json Outdated Show resolved Hide resolved
@@ -30,6 +30,7 @@ params {
with_umi = false
skip_umi_extract = false
umitools_extract_method = 'string'
umi_dedup_tool = 'umicollapse'
umitools_grouping_method = 'directional'
Copy link
Member

Choose a reason for hiding this comment

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

Reading that makes we wonder if we should be conservative regarding the parameter names or make them more generic, e.g. renaming umitools_grouping_method to something like umi_grouping_method / umi_dedup_grouping_method etc.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, I thought about that too. Depends on your policy for introducing breaking changes between versions. If the authors are OK, I can rename these parameters to be more generic.

workflows/rnaseq/main.nf Show resolved Hide resolved
workflows/rnaseq/main.nf Show resolved Hide resolved
workflows/rnaseq/nextflow.config Show resolved Hide resolved
workflows/rnaseq/nextflow.config Show resolved Hide resolved
Copy link
Author

@siddharthab siddharthab left a comment

Choose a reason for hiding this comment

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

Thanks for the quick review. I am tracking all remaining items in the PR summary.

@@ -30,6 +30,7 @@ params {
with_umi = false
skip_umi_extract = false
umitools_extract_method = 'string'
umi_dedup_tool = 'umicollapse'
umitools_grouping_method = 'directional'
Copy link
Author

Choose a reason for hiding this comment

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

Yes, I thought about that too. Depends on your policy for introducing breaking changes between versions. If the authors are OK, I can rename these parameters to be more generic.

nextflow_schema.json Outdated Show resolved Hide resolved
workflows/rnaseq/main.nf Show resolved Hide resolved
workflows/rnaseq/main.nf Show resolved Hide resolved
workflows/rnaseq/nextflow.config Show resolved Hide resolved
Signed-off-by: Siddhartha Bagaria <[email protected]>
@siddharthab
Copy link
Author

I checked the output of UMICollapse, and it definitely does not follow the assumptions stated in prepare_for_rsem.py. So PREPARE_FOR_RSEM will be needed for UMICollapse as long as it is needed for umi-tools.

@MatthiasZepper MatthiasZepper mentioned this pull request Oct 2, 2024
11 tasks
@siddharthab
Copy link
Author

@MatthiasZepper all remaining tasks are now done. Please take another look.

@MatthiasZepper
Copy link
Member

@MatthiasZepper all remaining tasks are now done. Please take another look.

Unfortunately, the UMICollapse module has not yet been upgraded...

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.

2 participants