simulatePedigrees: Pedigree Simulation

View source: R/simulatePedigree.R

simulatePedigreesR Documentation

Pedigree Simulation

Description

Pedigree Simulation

Usage

simulatePedigrees(fam.nf, nInitFounderCouples, probToMarry, probChildren)

Arguments

fam.nf

A integer vector where the entry i indicates the number of individuals at family i.

nInitFounderCouples

A integer value representing the number of founders in the first generation.

probToMarry

A scalar between 0 and 1 indicating the probability of a individual getting married. Marriages only occur between individuals of the same generation.

probChildren

A vector with values between 0 and 1 in which entry i indicates the probability of a couple has i children.

Examples

fam.nf <- rep(10, 20)  # for 20 families with 10 individuals
nInitFounderCouples <- 1
probChildren <- c(0, 0, 0.3, 0.3, 0.3, 0.1)
probToMarry = 0.85
pedigrees <- simulatePedigrees(fam.nf, nInitFounderCouples, probToMarry, probChildren)


adele/FamilyBasedPGMs documentation built on June 11, 2025, 5:48 a.m.