Elston: Compute a probability function on a pedigree

View source: R/Elston-algorithm.r

ElstonR Documentation

Compute a probability function on a pedigree

Description

Compute the probability of a pedigree, for a parameter theta and a given modele

Usage

Elston(ped, modele, theta, mem = new.env())

Arguments

ped

a pedigree, created by es.pedigree

modele

a modele

theta

a parameter for the modele

mem

an environment used for memoization

Details

This function runs Elston-Stewart algorithm. If mem is provided, some intermediate results of previous runs stored in it can be re-used.

Value

A list with two components, result: the probability value, and mem: an object storing intermediate results for future runs

See Also

Likelihood, es.pedigree

Examples

## cf Elston-Stewart vignette for more coments on this example
data(conrad2)
# creating an es.pedigree object
genotypes <- c( rep(list(0:2), 21), 2 )

X <- es.pedigree( id = conrad2$id, father = conrad2$father, mother = conrad2$mother, 
      sex = conrad2$sex, pheno = rep(0, 22), geno = genotypes )

# running Elston-Stewart
r <- Elston(X, modele.di, list(p = 0.98))
r$result

# using the memoization...
r <- Elston(X, modele.di, list(p = 0.99), r$mem)
r$result

ElstonStewart documentation built on June 20, 2022, 5:15 p.m.