Skip to content

Commit 0e19f97

Browse files
gregorgorjancjeromekelleher
authored andcommitted
Update display of pedigree information in documentation
1 parent 59897ab commit 0e19f97

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

docs/pedigrees.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,8 @@ mom_id = pb.add_individual(time=1)
6969
dad_id = pb.add_individual(time=1)
7070
pb.add_individual(time=0, parents=[mom_id, dad_id], is_sample=True)
7171
pedigree = pb.finalise()
72-
# TODO replace with display(pedigree) when its implemented in tskit
73-
# https://github.com/tskit-dev/tskit/issues/2093
74-
print(pedigree)
72+
display(pedigree.individuals)
73+
display(pedigree.nodes)
7574
```
7675

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

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

104-
105104
(sec_pedigrees_metadata)=
106105

107106
## Metadata
@@ -147,7 +146,6 @@ See the
147146
for examples.
148147
:::
149148

150-
151149
(sec_pedigrees_file_format_definition)=
152150

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

280-
281278
### Demography information
282279

283280
If the founder individuals of the pedigree belong to different populations

0 commit comments

Comments
 (0)