-
Notifications
You must be signed in to change notification settings - Fork 17
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
[Freyja] Update freyja to version 1.5.2, expose pathogen flag and minor update to docs #684
Conversation
…reyja_usher_barcodes to freyja_barcodes; update docs
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.
All changes and updates look good. Couldn't find any syntax or logic snafus. Will test.
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.
Programmatically changes look good and make sense. Version for docker is bumped, freyja_pathogen is exposed as an optional string, freyja_usher_barcodes
--> freyja-barcodes
. --pathogen
added to freyja boot
command. Again freyja_usher_barcodes
variable switched for more general freyja_barcodes
.
To echo what Ines pointed out about the When you run Freyja, it needs reference files (barcodes and lineage information) to work. You have three ways to provide these:
If you provide you own custom barcode files, Freyja will use your files, it will ignore any other settings about which pathogen to look for since |
Test with Test with Test with both update_db set to true and pathogen set to "SARS-CoV-2" Will test with non sars-cov-2 specific organisms next. |
Final test with MPXV looks good when passed with the pathogen flag. Non SARS-CoV-2 data needs to be specified with |
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.
After small doc change, everything is good.
This PR closes #655
🗑️ This dev branch should be deleted after merging to main.
🧠 Summary
This PR does the following:
freyja_pathogen
for easier support for non-SC2 pathogensThere's a few quirks with the
pathogen
flag. If barcodes are passed, even if the organisms flag is used, it will be ignored and the provided barcodes will take precedence. the user can still use the --update-db and the pathogen flag but they behave the same way. Functionally they are the same as in they will fetch the latest barcodes from the repository automatically. For compatibility purposes theupdate_db
option was not removed.⚡ Impacted Workflows/Tasks
All the Freyja workflows, but all but Freyja_FASTQ_PHB had just the docker updated.
This PR may lead to different results in pre-existing outputs: Yes if update_db or freyja_pathogen is used
This PR uses an element that could cause duplicate runs to have different results: Yes if update_db or freyja_pathogen is used
🛠️ Changes
⚙️ Algorithm
The Freyja
pathogen
flag is now exposed as input in Freyja_FASTQ_PHB.➡️ Inputs
New input:
Altered inputs:
⬅️ Outputs
No outputs have been changed
🧪 Testing
SC2
NON-SC2
Suggested Scenarios for Reviewer to Test
More non-SC2 organisms but it's really hard to find samples! One measles sample can be found here: https://andersen-lab.github.io/Freyja/src/wiki/freyja-measles.html
🔬 Final Developer Checklist
🎯 Reviewer Checklist