kinship_std_limit: Limit of standard kinship estimator

In OchoaLab/popkinsuppl: Supplement to popkin package

Limit of standard kinship estimator

Description

This function calculates the biased limiting expectation of the standard kinship estimator. This limit is easily calculated given the true kinship matrix and the weights used to estimate the ancestral allele frequency.

Usage

kinship_std_limit(kinship, weights = NULL)

Arguments

kinship	The true kinship matrix
weights	Optional weights for individuals

Value

The biased limit of the standard kinship estimator

See Also

Standard kinship estimator kinship_std().

Examples

# create a dummy kinship matrix
kinship <- matrix(
    c(
        0.6, 0.1, 0,
        0.1, 0.6, 0.1,
        0, 0.1, 0.6
        ),
    nrow = 3
)
# this is its biased limit
# (uniform weights)
kinship_biased_limit <- kinship_std_limit(kinship)

OchoaLab/popkinsuppl documentation built on May 17, 2022, 9:50 a.m.