Create data documentation md file #13
Merged
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
tskir
requested changes
Jun 4, 2020
|
Great, all comments addressed without further issues, merging this |
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.
This PR contains a markdown file containing documentation for the data model as well as the trait status transitions, along with a mermaid diagram and its source code. Closes #7 , closes #8
A consideration I have is that the table describing the trait statuses is very big and therefore the markdown required to output it is quite not user-friendly, so we might want to change the way we show that piece of information.
I also uploaded the png diagram to Imgur so that is stays permanently and that the link is small