Adds Vibecheck to the Vibrio spp. subworkflow of TheiaProk #763
+576
−463
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 dev branch should be deleted after merging to main.
🧠 Summary
This PR adds a additional task to the Vibrio spp. subworkflow of TheiaProk which runs Vibecheck. Vibecheck rapidly classifies V. cholerae sequencing data to canonical lineages (T1-T17/AFR1-AFR17).
⚡ Impacted Workflows/Tasks
This PR may lead to different results in pre-existing outputs: No
This PR uses an element that could cause duplicate runs to have different results: No
🛠️ Changes
This PR adds an additional task task_vibecheck_vibrio.wdl, which is called during Vibrio spp. branch of the
merlin_magic
workflow. Therefore, the inputs, parameters, and outputs of the additional task were added towf_merlin_magic.wdl
andwf_theiaprok_illumina_pe.wdl
⚙️ Algorithm
No changes were made to existing algorithms or processes. However, inputs, parameters, and outputs were added for the Vibecheck task.
➡️ Inputs
The following inputs were added. All are optional.
vibecheck_lineage_barcode
vibecheck_subsampling_fraction
vibecheck_skip_subsampling
vibecheck_docker_image
⬅️ Outputs
The following outputs were added:
vibecheck_lineage_report
vibecheck_top_lineage
vibecheck_confidence
vibecheck_classification_notes
vibecheck_version
vibecheck_docker
🧪 Testing
I've manually tested a similar task in the Vibecheck Github repo. However, I'm unclear how exactly to test this specific task locally. Any advise or recommendations you have would be much appreciated.
Suggested Scenarios for Reviewer to Test
Success and accuracy of classification should be tested. I can provide raw data for cholera isolates with known lineage classifications if it's helpful.
🔬 Final Developer Checklist
workflows_overview
tables to be the tag for the next upcoming release. If you do not know the tag, please put "vX.X.X"🎯 Reviewer Checklist