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

Deletion state parameterization #27

Merged
merged 5 commits into from
Aug 9, 2023

Conversation

yashpatel6
Copy link
Collaborator

Description

Adding customization option for which states to delete with the metapipeline

Testing Results

Outputs: /hot/software/pipeline/pipeline-recalibrate-BAM/Nextflow/development/unreleased/yashpatel-parameterize-deletion-by-state

  • '/delete_both/' - delete both normal and tumor BAMs
  • /delete_tumor_only/ - delete only tumor BAM

Checklist

  • I have read the code review guidelines and the code review best practice on GitHub check-list.

  • I have reviewed the Nextflow pipeline standards.

  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].

  • I have set up or verified the branch protection rule following the github standards before opening this pull request.

  • I have added my name to the contributors listings in the manifest block in the nextflow.config as part of this pull request, am listed
    already, or do not wish to be listed. (This acknowledgement is optional.)

  • I have added the changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.

  • I have updated the version number in the metadata.yaml and manifest block of the nextflow.config file following semver, or the version number has already been updated. (Leave it unchecked if you are unsure about new version number and discuss it with the infrastructure team in this PR.)

  • I have tested the pipeline on at least one A-mini sample.

Copy link

@tyamaguchi-ucla tyamaguchi-ucla left a comment

Choose a reason for hiding this comment

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

Looks good! Was this requested by an end user or more for debugging purposes? @yashpatel6

@yashpatel6
Copy link
Collaborator Author

This is actually to resolve users running metapipeline with 1 normal, multiple tumors in paired mode; in that case, call-gSNP deletes the normal BAM after the first tumor and we end up getting an error with the next tumor since it requires the normal BAM.

@@ -14,6 +14,7 @@ params {
cache_intermediate_pipeline_steps = false

metapipeline_delete_input_bams = false
metapipeline_states_to_delete = ['normal', 'tumor']

Choose a reason for hiding this comment

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

If this is meant as a customizable option, wouldn't it be better to move this to template.config or add a placeholder in template.config for users to define if they want to delete tumor or normal?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Generally, this option is for customization but not for general users; it's meant for customization through the metapipeline to handle the issue in my comment above

A user running this pipeline shouldn't be using the metapipeline_* params since they would end up deleting input BAMs anyways; these options are specifically to handle deletion for metapipeline to optimize /scratch usage

Choose a reason for hiding this comment

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

gotcha!

Copy link

@Faizal-Eeman Faizal-Eeman left a comment

Choose a reason for hiding this comment

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

looks good

@tyamaguchi-ucla
Copy link

This is actually to resolve users running metapipeline with 1 normal, multiple tumors in paired mode; in that case, call-gSNP deletes the normal BAM after the first tumor and we end up getting an error with the next tumor since it requires the normal BAM.

Ah, now I recall the context. Did the user who encounter the error open an issue? (maybe the user used the metapipeline-repo?) If not, We would want to keep a record of the actual example.

@yashpatel6
Copy link
Collaborator Author

This is actually to resolve users running metapipeline with 1 normal, multiple tumors in paired mode; in that case, call-gSNP deletes the normal BAM after the first tumor and we end up getting an error with the next tumor since it requires the normal BAM.

Ah, now I recall the context. Did the user who encounter the error open an issue? (maybe the user used the metapipeline-repo?) If not, We would want to keep a record of the actual example.

I'm the user who encountered the issue during testing, with the same samples I use for the multi-sample testing, just in paired mode 👀

@tyamaguchi-ucla
Copy link

This is actually to resolve users running metapipeline with 1 normal, multiple tumors in paired mode; in that case, call-gSNP deletes the normal BAM after the first tumor and we end up getting an error with the next tumor since it requires the normal BAM.

Ah, now I recall the context. Did the user who encounter the error open an issue? (maybe the user used the metapipeline-repo?) If not, We would want to keep a record of the actual example.

I'm the user who encountered the issue during testing, with the same samples I use for the multi-sample testing, just in paired mode 👀

Got it. This is still related to the Mutect2 issue that we recently fixed, right? Just wanted to understand the context a bit more.

@yashpatel6
Copy link
Collaborator Author

Not exactly related; this is just a case (multi-tumor run in paired mode) that we haven't encountered since adding the metapipeline input deletion to call-gSNP so it's coming up now and will be included when I update metapipeline to split call-gSNP

@tyamaguchi-ucla
Copy link

Not exactly related; this is just a case (multi-tumor run in paired mode) that we haven't encountered since adding the metapipeline input deletion to call-gSNP so it's coming up now and will be included when I update metapipeline to split call-gSNP

Got it. Thanks for the clarification!

@yashpatel6 yashpatel6 merged commit 22890fd into main Aug 9, 2023
1 check passed
@yashpatel6 yashpatel6 deleted the yashpatel-parameterize-deletion-by-state branch August 9, 2023 18:34
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