Skip to content

Update display of pedigree information in documentation #2517

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
jeromekelleher merged 1 commit into from
Mar 6, 2026
Merged

Update display of pedigree information in documentation #2517

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
9 changes: 3 additions & 6 deletions docs/pedigrees.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,8 @@ mom_id = pb.add_individual(time=1)
dad_id = pb.add_individual(time=1)
pb.add_individual(time=0, parents=[mom_id, dad_id], is_sample=True)
pedigree = pb.finalise()
# TODO replace with display(pedigree) when its implemented in tskit
# https://github.com/tskit-dev/tskit/issues/2093
print(pedigree)
display(pedigree.individuals)
display(pedigree.nodes)
```

The pedigree returned by the {meth}`~.PedigreeBuilder.finalise` method
Expand All @@ -80,6 +79,7 @@ contains the pedigree information defined by the calls to
the parents, and because they are founders, we don't provide any information
about their parents. Each call to {meth}`~.PedigreeBuilder.add_individual`
returns the integer ID of newly added individual.

### Requirements

This section lists the detailed requirements of the low-level encoding
Expand All @@ -101,7 +101,6 @@ API or the {ref}`sec_pedigrees_file_format`.
time and population, as a shorthand.)
- An individual's time must be less than all its parent's times.


(sec_pedigrees_metadata)=

## Metadata
Expand Down Expand Up @@ -147,7 +146,6 @@ See the
for examples.
:::


(sec_pedigrees_file_format_definition)=

### Format definition
Expand Down Expand Up @@ -277,7 +275,6 @@ Here we have two trios, where the child in the second trio is from the
same generation as the parents in the second. We use the ``is_sample``
column to specify that ``child2`` is a sample as well as ``child1``.


### Demography information

If the founder individuals of the pedigree belong to different populations
Expand Down