Skip to content
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

Data model and Tables API section #1

Open
jeromekelleher opened this issue Jul 22, 2021 · 2 comments
Open

Data model and Tables API section #1

jeromekelleher opened this issue Jul 22, 2021 · 2 comments

Comments

@jeromekelleher
Copy link
Member

I think we should have a section that describes the data model and (briefly) the Tables API. A diagram of the various entities would be helpful here?

@jeromekelleher jeromekelleher changed the title Data model and Tables API Data model and Tables API section Jul 22, 2021
@benjeffery
Copy link
Member

I made this UML a little while back:
Screenshot from 2021-07-22 23-50-43
Here's the VPD file (editable at https://online.visual-paradigm.com):
tskit.vpd.zip

@jeromekelleher
Copy link
Member Author

Looks like a good starting point to me.

I wonder if we should leave the migration table out of this for the purposes of the paper - we don't do anything with them in the library, and arguably they are redundant now we have the full ARG support in msprime (which I think stores the same information, via nodes and edges).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants