Skip to content

update subset docs - no support for migration table #690

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 24, 2020
Merged

update subset docs - no support for migration table #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions c/tskit/tables.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2424,9 +2424,8 @@ each of the tables as follows:
3. Edges: if both parent and child are retained nodes.
4. Mutations: if the mutation's node is a retained node.
5. Sites: if any mutations remain at the site after removing mutations.
6. Migrations: if the migration's node is a retained node.

Retained edges, mutations, sites, and migrations appear in the same
Retained edges, mutations, and sites appear in the same
order as in the original tables.

If ``nodes`` is the entire list of nodes in the tables, then the
Expand Down
3 changes: 1 addition & 2 deletions python/tskit/trees.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4483,9 +4483,8 @@ def subset(self, nodes, record_provenance=True):
3. Edges: if both parent and child are retained nodes.
4. Mutations: if the mutation's node is a retained node.
5. Sites: if any mutations remain at the site after removing mutations.
6. Migrations: if the migration's node is a retained node.

Retained edges, mutations, sites, and migrations appear in the same
Retained edges, mutations, and sites appear in the same
order as in the original tables.

If ``nodes`` is the entire list of nodes in the tables, then the
Expand Down