GENLIB (version 1.0.9)

gen.meangendepth: Expected Genealogical Depth

Description

Returns the expected genealogical depth.

Usage

gen.meangendepth( gen, pro = "0", type = "MEAN", ...)

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.

type

If type="MEAN" (default), mean genealogical depth over all specified probands is calculated. If type="IND", mean genealogical depth is calculated for each specified proband.

...

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

Value

A data frame with only one numeric value when type is "MEAN". When type is "IND", the number of rows equals the number of probands specified.

References

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

Kouladjian K. (1986) Une mesure d'entropie genealogique. Chicoutimi, SOREP, Document III-C-43.

De Brakaeleer M, Bellis G. (1994) Genealogies et reconstitutions de familles en genetique humaine. Dossiers et Recherches, no 43, INED, Paris.

See Also

gen.genealogy gen.occ gen.implex gen.rec gen.completeness gen.gc

Examples

# NOT RUN {
data(geneaJi) 
genJi<-gen.genealogy(geneaJi) 
gen.meangendepth(genJi)
gen.meangendepth(genJi, type="IND")


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

# }