-
Notifications
You must be signed in to change notification settings - Fork 18
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
[Kraken2] Update Krona to be compatible with viral data #709
base: main
Are you sure you want to change the base?
Conversation
@cimendes i will want your eyes on this because i'm not sure how good this approach is and if it is what we want |
|
||
# Get taxonomy file | ||
ktUpdateTaxonomy.sh taxonomy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sage-wright any reason why this step is no longer needed? This was used to update the NCBI's taxonomy file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now that I looked a little better, krImportText doesn't require a taxonomy file (source: https://github.com/marbl/Krona/wiki/Installing) so good call!
|
||
# Run krona with taxonomy on krakren report | ||
ktImportTaxonomy -o ~{samplename}_krona.html ~{kraken2_report} -tax taxonomy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For reference purposes: https://github.com/marbl/Krona/wiki/Importing-text-and-XML-data
Overall I think this is a valid approach to getting those Krona reports. It relies on two dependencies instead of just one but I think it's a fair trade-off to get the viral components of a community represented in the final plots.
Let me know once it's ready for review and I'll start testing! |
This doesn't affect Kraken ONT -- we're not running krona in that workflow |
This PR closes #278 and closes #518
🗑️ This dev branch should be deleted after merging to main.
🧠 Summary
Krona for a while now has been incompatible with viral data due to a weird quirk where viral data was appearing in the krona plots as "Other root" which wasn't really what we wanted. This PR preprocesses the Kraken2 reports with KrakenTools to make the viral data appear appropriately in the HTML plots.
⚡ Impacted Workflows/Tasks
This PR may lead to different results in pre-existing outputs: Yes
This PR uses an element that could cause duplicate runs to have different results: No
🛠️ Changes
⚙️ Algorithm
us-docker.pkg.dev/general-theiagen/staphb/krona:2.8.1
kreport2krona
before making the krona visualization➡️ Inputs
None
⬅️ Outputs
None
🧪 Testing
Suggested Scenarios for Reviewer to Test
🔬 Final Developer Checklist
workflows_overview
tables.🎯 Reviewer Checklist