Skip to content

Commit 0909034

Browse files
hyanwongmergify[bot]
authored andcommitted
Document reason for 2 re nodes
Fixes #2365
1 parent d5ecfd0 commit 0909034

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/ancestry.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1152,10 +1152,14 @@ as gene conversion. A separate {class}`msprime.NodeType` exists for each:
11521152
A recombination event results in two extra nodes being recorded, one identifying
11531153
the genome providing the genetic material to the left of the breakpoint and
11541154
the other identifying the genome providing the genetic material to the
1155-
right. For more information on how to set the recombination rate or specify a
1156-
recombination map: see {ref}`sec_ancestry_recombination`. More information on how
1157-
to set up a simulation with gene conversion can be found here:
1158-
{ref}`sec_ancestry_gene_conversion`.
1155+
right. This makes it easy to identify the (possible multiple) segments of genome
1156+
that travel via the left parent versus the right parent, and also means that
1157+
so-called "diamonds" (in which lineages split and immediately rejoin) are retained
1158+
even if edges are {meth}`squashed<tskit.EdgeTable.squash>`.
1159+
1160+
For more information on how to set the recombination rate or specify a
1161+
recombination map: see {ref}`sec_ancestry_recombination`. To set up a simulation
1162+
with gene conversion, see {ref}`sec_ancestry_gene_conversion`.
11591163

11601164
(sec_ancestry_record_migrations)=
11611165

0 commit comments

Comments
 (0)