Learn R Programming

GENLIB (version 1.1.10)

gen.phiCI: Average kinship confidence interval

Description

Returns the confidence interval of the average kinship among pairs of specified individuals

Usage

gen.phiCI(phiMatrix, prob=c(0.025,0.05,0.95,0.975), b=5000, print.it=FALSE)

Value

A vector or a GLmultiVector object depending on the type of 'phiMatrix' entered. If 'phiMatrix' is a GLmultiMatrix, an array of vectors (GLmultiVector), one for each depth, is returned. Array of size ('depthMax'-'depthMin'), vectors of size 'length(probs)'. If 'phiMatrix' is a matrix, a vector of size 'length(probs)' is returned.

Arguments

phiMatrix

A square matrix of kinship coefficients obtained for example with gen.phi, or an array of square matrices (GLmultiMatrix object) of kinship coefficients obtained with gen.phi. Required.

prob

Confidence limits probabilities. Default is probs=c(0.025, 0.05, 0.95, 0.975).

b

Number of simulations used to calculate the confidence interval. Default is b="5000".

print.it

If print.it=FALSE (default), progression in the number of simulations performed is not displayed.

See Also

gen.genealogy gen.phi gen.phiOver gen.phiMean

Examples

Run this code
# \donttest{
data(genea140)
gen140<-gen.genealogy(genea140)
ge07<-gen.branching(gen140, pro=gen.pro(gen140)[c(1:7)])
phiMat<-gen.phi(ge07)
gen.phiCI(phiMat)
# }

Run the code above in your browser using DataLab