doc: add documentation for the lineage_definitions format #652
Conversation
This file contains 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
|
There is no change in the changelog. This PR will not produce a new releasable version. |
Taepper
force-pushed
the
lineage-defininitions-doc
branch
2 times, most recently
from
f00f6bb to
8b96072
Compare
fengelniederhammer
added
the
documentation
|
Linking GenSpectrum/LAPIS#978 for reference. |
There was a problem hiding this comment.
What's the scope of this? This is a very formal description. For a quick "let's pin down the schema", this is good. But it's not something that maintainers would understand, because it's not comprehensive enough (IMO). What does it mean to define those lineage? What consequences does it have on the data at runtime? How can users query it?
|
I wanted something that is at least one step above "ah, I found an example in the codebase" which is what happened now for Loculus ^^ |
fengelniederhammer
approved these changes
Nov 27, 2024
Taepper
force-pushed
the
lineage-defininitions-doc
branch
from
8b96072 to
0983f88
Compare
|
Ok, fixed a typo in the commit message and will merge afterward |
Taepper
changed the title
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
Add documentation for the lineage definitions file, which is required for the specification of monophyletic sublineage queries.
PR Checklist