Add construct-aware paired-guide decoding to screening - #279
Draft
Yifan1835 wants to merge 1 commit into
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
--screening_count_method crisprdecodecounting path to the screening workflow while retaining MAGeCK as the defaultMotivation
The existing screening path assumes that one sequenced spacer identifies one sgRNA. Paired-guide libraries encode construct identity using two observed guide elements, so treating each read as a conventional single guide can lose construct identity and conceal ambiguous signatures. This contribution adds a bounded construct-aware count-generation path that rejoins the existing workflow at
ch_counts; downstream CRISPRcleanR, MAGeCK, BAGEL2, DrugZ and HitSelection behavior is unchanged.User impact
Users can select paired-guide counting with:
The construct library is a headered TSV with
construct_id,target_id,spacer_r1andspacer_r2. Optional per-read anchor, offset and reverse-complement parameters describe the supported read geometry. The default value remainsmageck, and a regression nf-test verifies the existing MAGeCK route.Validation
python3 -m unittest discover -s tests/crisprdecode -v— 6 tests passednextflow run main.nf --helpwith Nextflow 25.04.0 passed full workflow parsinggit diff --checkpassedThe repository's
latest-everythingNextflow matrix is allowed to fail. Locally, Nextflow 26.04.6 fails before this implementation executes because nf-test 0.9.3 generates strict-syntax-incompatible*input; the required 25.04.0 matrix passes.Scope
This MVP supports paired-end paired-guide libraries with exact matching and one downstream target label per construct. UMI/iBAR processing, pooled pegRNA libraries and combinatorial two-target statistical models remain out of scope.
Closes #278