inheritance_space: Inheritance space for pedigree

In ibdsegments: Identity by Descent Probability in Pedigrees

Inheritance space for pedigree

Description

The inheritance_space function determines the space of IBD vectors for a pedigree. This is mostly for internal use but may be interesting by itself.

Usage

inheritance_space(pedigree, ids, states = "ibd", exploit_symmetries = TRUE)

Arguments

pedigree	Pedigree in pedtools::ped form.
ids	Ids for which IBD is observed. Default is pedtools::leaves(pedigree).
states	One of "ibd" (default), "kappa", "identity" or "detailed".
exploit_symmetries	Should symmetries be used to reduce to state space? This can be set to FALSE for debugging purposes.

Value

Object of class inheritance_space.

Examples

# set up inheritance space for half sib pedigree
i <- inheritance_space(pedigree = pedtools::halfSibPed())

# since there are 2 non-founders, there are 2^4 IBD vectors
# but only 2 distinct states are considered because of symmetries
i

# pry into the internals to see individual pedigree transmissions
i$transmissions

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