[Read_Screen] skip_screen actually skips the screen #699
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #677
🗑️ This dev branch should be deleted after merging to main.
🧠 Summary
For years and years, the read_screen task was advertised as skippable, and while it theoretically did not perform any screening, the task and VM was still spun up so the task itself was not skipped. This was due to my unexperienced self not really knowing what she was doing and also it being my very first addition to the Theiagen code base all those years ago.
Because of that, I am finally fixing this terribly inadequate solution and am making an improvement wherein if the
skip_screen
variable is set to true, the read_screen task is never even run or touched, which is much improved.⚡ Impacted Workflows/Tasks
Workflows:
Tasks:
This PR may lead to different results in pre-existing outputs: Yes
Instead of the
read_screen
output variable saying PASS it will be blank, since the screen didn't run.This PR uses an element that could cause duplicate runs to have different results: No
🛠️ Changes
⚙️ Algorithm
The read screen is actually skipped instead of started and all internal processes skipped. No more needless VM creation!
!!!!!⚠️ if you're skipping the screen in theiaeuk, PLEASE provide an expected genome size or RASUSA will try to downsample to a genome size of 0 and that will make it very unhappy so... not sure how else to get around that lol
➡️ Inputs
None
⬅️ Outputs
None
🧪 Testing
Please admire the LACK of read_screen tasks in the following workflows where
skip_screen
was set to true:AND THE PRESENCE OF when
skip_screen
is blank/default false:Please note that though several of these tasks are failing, those failures are completely unrelated to this PR and are actually just due to me being a silly goose and not giving the workflow the right primer bed files or references or using bad data so all of these workflows reveal that what I did worked as intended.
Suggested Scenarios for Reviewer to Test
If you are afraid of the previous statement I made and are rightfully judgmental of my admittedly shoddy testing, you may want to rerun some of those tests that have failure marks to make them go green though I am confident they will once you give the workflow what it needs: the right primers/appropriate references/actually good data.
🔬 Final Developer Checklist
workflows_overview
tables.🎯 Reviewer Checklist