-
Notifications
You must be signed in to change notification settings - Fork 78
Update glossary.md #3340
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
Update glossary.md #3340
Conversation
Reference ARGs in the glossary
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3340 +/- ##
=======================================
Coverage 89.76% 89.76%
=======================================
Files 29 29
Lines 31289 31292 +3
Branches 5737 5738 +1
=======================================
+ Hits 28086 28089 +3
Misses 1794 1794
Partials 1409 1409
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
docs/glossary.md
Outdated
| aligned DNA sequences. The name reflects the idea that a common | ||
| way to treat genetic ancestry is as a sequence of correlated | ||
| "trees" along the genome; a tree sequence provides an efficient | ||
| way to store differences between these trees. Technically, ancestry |
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.
| way to store differences between these trees. Technically, ancestry | |
| way to store shared branches between these trees. Technically, ancestry |
The edge table is storing what is shared, not what is different across local trees. I know this is nitpicking, but thinking in terms of differences I have read in many places really confused me when I started to read about what is tree sequence. The left-right algorithms work with differences, I believe.
|
Hi @gregorgorjanc - I have reworded slightly to take account of your point, and also added a glossary item for |
|
@hyanwong thanks for considering my nitpicking comment;) It reads very clear to me now. I have spotted one typo. Otherwise LGTM! |
Co-authored-by: Gregor Gorjanc <[email protected]>
|
Excellent, thanks for spotting that (and accepted) |
Co-authored-by: Jerome Kelleher <[email protected]>
Reference ARGs in the glossary when defining a "tree sequence". I hope this clarifies rather than adds to any confusion.
We can address the "what is a tree sequence" stuff in the tutorials too.