inheritance_pattern: Inheritance pattern for inheritance vectors

In ibdsegments: Identity by Descent Probability in Pedigrees

Inheritance pattern for inheritance vectors

Description

The inheritance_pattern function determines the inheritance pattern for all pedigree members by dropping the founder allele labels down the pedigree according to the IBD vector v.

Usage

inheritance_pattern(inheritance_space, v)

Arguments

inheritance_space	Output of inheritance_space.
v	Integer.

Value

Data frame describing inheritance pattern and IBD state for each v.

Examples

ped_fs <- pedtools::nuclearPed(nch = 2)
i <- inheritance_space(ped_fs, ids = 3:4)

# show the inheritance pattern and IBD state for all canonical IBD vectors
inheritance_pattern(i, v = 0:3)

# without exploiting founder symmetry
i2 <- inheritance_space(ped_fs, ids = 3:4, exploit_symmetries = FALSE)
inheritance_pattern(i2, v = 0:15)

ibdsegments documentation built on June 8, 2025, 11:40 a.m.