gen.implexVar: Variance of genealogical implex

View source: R/fonctionsBase.R

gen.implexVarR Documentation

Variance of genealogical implex

Description

Returns the variance of the implex index across probands.

Usage

gen.implexVar( gen, pro = "0", onlyNewAnc = FALSE, 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.

onlyNewAnc

If onlyNewAnc=FALSE (default), all ancestors will be considered. If onlyNewAnc=TRUE, only new ancestors will be counted (i.e., an ancestor is not counted again if it has already been counted in another generation).

genNo

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

...

Additionnal arguments to be passed to methods.

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.implex(genJi, type="IND")
gen.implexVar(genJi)
# For the 5th generation
gen.implexVar(genJi, genNo=5)


data(genea140) 
gen140<-gen.genealogy(genea140) 
gen.implex(gen140)
gen.implex(gen140, pro=c(454422, 676521, 677273, 717537, 717634, 717709, 868572), type="IND")
gen.implexVar(gen140, pro=c(454422, 676521, 677273, 717537, 717634, 717709, 868572), type="IND")


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

Related to gen.implexVar in GENLIB...