kinship: Calculate kinship coefficients

View source: R/idcoef.R

kinshipR Documentation

Calculate kinship coefficients

Description

Calculate kinship coefficients from a pedigree.

Usage

kinship(ped, ids, all = TRUE, msg = TRUE)

Arguments

ped

A pedigree, which a data frame (id, sire, dam, ...). If given, "generation" can be numeric 0, 1, 2, ... or non-numeric "F0", "F1", "F2", ... If "sex" is included, male should be "M", "Male" or 1, and female should be "F", "Female" or 2 (other than 0 and 1). If a founder is inbred, its ID should be tagged by character 'i' (e.g. 1i, 2i, etc.). Note that 0 is reserved for missing values.

ids

IDs of the individuals. If given, kinship coefficients are extracted for individuals with ID ids; otherwise, kinship coefficients are provided for all individuals in the pedigree.

all

If false, sires and dams with no parents are treated as unknown.

msg

If false, messages are suppressed.

Value

A matrix giving kinship coefficients.

Examples

data(miscEx)

ids<- sample(pedF8$id,10)
## Not run: 
ksp<- kinship(pedF8,ids=ids)

## End(Not run)

QTLRel documentation built on Aug. 9, 2023, 1:07 a.m.

Related to kinship in QTLRel...