Fa {purgeR}R Documentation

Ancestral inbreeding coefficient

Description

Computes the ancestral inbreeding coefficient (Fa). This is the probability that an allele has been in homozygosity in at least one ancestor (Ballou 1997). A genedrop approach is included to compute unbiased estimates of Fa (Baumung et al. 2015).

Usage

Fa(ped, Fi, name_to, genedrop = 0L, seed = NULL)

Arguments

ped

A dataframe containing the pedigree. Individual (id), maternal (dam), and paternal (sire) identities are mandatory columns.

Fi

Vector of inbreeding coefficient values

name_to

A string naming the new output column.

genedrop

Number of genedrop iterations to run. If set to zero (as default), Ballou's Fa is computed.

seed

Sets a seed for the random number generator.

Value

The input dataframe, plus an additional column named "Fa" with individual ancestral inbreeding coefficient values.

References


[Package purgeR version 1.8.2 Index]