Skip to content

Document reason for 2 re nodes #2366

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
mergify merged 1 commit into from
May 7, 2025
Merged

Document reason for 2 re nodes #2366

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
12 changes: 8 additions & 4 deletions docs/ancestry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1152,10 +1152,14 @@ as gene conversion. A separate {class}`msprime.NodeType` exists for each:
A recombination event results in two extra nodes being recorded, one identifying
the genome providing the genetic material to the left of the breakpoint and
the other identifying the genome providing the genetic material to the
right. For more information on how to set the recombination rate or specify a
recombination map: see {ref}`sec_ancestry_recombination`. More information on how
to set up a simulation with gene conversion can be found here:
{ref}`sec_ancestry_gene_conversion`.
right. This makes it easy to identify the (possible multiple) segments of genome
that travel via the left parent versus the right parent, and also means that
so-called "diamonds" (in which lineages split and immediately rejoin) are retained
even if edges are {meth}`squashed<tskit.EdgeTable.squash>`.

For more information on how to set the recombination rate or specify a
recombination map: see {ref}`sec_ancestry_recombination`. To set up a simulation
with gene conversion, see {ref}`sec_ancestry_gene_conversion`.

(sec_ancestry_record_migrations)=

Expand Down
Loading