Clarify bite calculation: documentation and code comments#587
Closed
Clarify bite calculation: documentation and code comments#587
Conversation
Co-authored-by: carolinamonzo <24670602+carolinamonzo@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Identify location of bite calculation in code
Clarify bite calculation: documentation and code comments
Mar 9, 2026
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.
bite(classification column 25) andbite_junction(junction column 13) lacked meaningful descriptions, making it impossible to understand what the fields represent or where they originate without reading the source.Changes
docs/Understanding-the-output-of-SQANTI3-QC.mdbite(col 25): Expanded to explain it reflects whether any junction in the isoform hasbite_junction == TRUE; mono-exonic transcripts default toNA; cross-references junction glossary.bite_junction(col 13): Explained the exact TRUE condition (novel intron extends past reference splice sites on both ends), the relationship todiff_to_Ref_start_site/diff_to_Ref_end_site, and that known junctions are alwaysFALSE.src/classification_steps.py: Added inline comments documenting the sign semantics ofmin_diff_s/min_diff_eand the logic behind thebite_junctionformula:src/qc_computations.py: Added comment on thebiteaggregation: once any junction sets itTRUE, subsequentFALSEjunctions do not override it.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.