gen.completenessVar: Variance of completeness index

View source: R/fonctionsBase.R

gen.completenessVarR Documentation

Variance of completeness index

Description

Returns the variance of the completeness index across probands.

Usage

gen.completenessVar( gen, pro = "0", genNo = -1, ...)

Arguments

gen

An object of class GLgen obtained with gen.genealogy, gen.lineages or gen.branching. Required.

pro

Vector of proband id numbers to be included. Default is 0, which will select all individuals without children.

genNo

Vector of generation numbers at which completeness should be calculated. Default is -1, which calculates completeness at each generation.

...

Option to pass additionnal arguments automaticaly between methods. Internal use only.

Value

A data frame with one column and each generation at which the variance is calculated as rows.

References

Cazes P, Cazes MH. (1996) Comment mesurer la profondeur genealogique d'une ascendance? Population (French Ed) 51:117-140.

See Also

gen.gc

Examples

data(geneaJi) 
genJi<-gen.genealogy(geneaJi) 
gen.completeness(genJi, type="IND")
gen.completenessVar(genJi)
# For the 4th generation
gen.completenessVar(genJi, genNo=4)


data(genea140) 
gen140<-gen.genealogy(genea140) 
gen.completeness(gen140)
gen.completenessVar(gen140)


GENLIB documentation built on Jan. 17, 2023, 5:16 p.m.