paramlink (version 1.1-6)

randomPed: Random pedigree

Description

Creates a random medical pedigree with specified number of generations.

Usage

randomPed(
  gen,
  lambda = 2,
  penetrances = c(0, 1, 1),
  naff = "last.gen",
  founder.mut = 1
)

Value

A linkdat object.

Arguments

gen

an integer in the interval [2,5] indicating the number of generations.

lambda

a positive numeric. For each descendant of the first generation, the number of offspring is sampled from a Poisson distribution with parameter lambda.

penetrances

a numeric of length 3, as in setModel.

naff

an integer specifying a lower bound on the number of affected individuals, or the character 'last.gen'. The latter produce a pedigree where at least one in the youngest generation is affected.

founder.mut

an integer, the number of disease alleles to be distributed among the founders.

Details

The function produces a random simple pedigree. Each founder is given at most one disease allele. At least one of the two top founders carries a disease allele.

See Also

linkdat

Examples

plot(randomPed(3))

# gives error message: Not enough founder mutations
if (FALSE) {
randomPed(gen=4, penetrances=c(0,0,1), naff=2, founder.mut=1)
}