Fix #150: document assembly assumptions#158
Merged
Merged
Conversation
Add module docstrings to assembly.py and variant_sequence.py documenting that the assembly requires exact sequence matches (breaks with long-read error rates) and that coverage trimming assumes monotonic decay (breaks with splice-junction reads). Add a note to README's Sequencing Recommendations section. Fixes #150
|
coverage: 93.174%. remained the same — fix-150-document-assembly-assumptions into master |
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
2 participants
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
assembly.py: exact-match and shared-alt requirementsvariant_sequence.py: monotonic coverage assumptionFixes #150
Test plan
./test.shpasses (169 tests)./lint.shpasses