RelComb {Relatedness}

Computation of Linear Combination of Relatedness Coefficients

Description

Compute any relatedness synthetic criterion based on a linear combination of the relatedness coefficients.

Usage

RelComb(Combination, Delta, 
		 Crossing = matrix(0, nrow = 0, ncol = 0), 
		 ParentPop = rep(0, 0), 
		 ShowIdentifiable = TRUE)

Arguments

Combination

A vector, with length identical to the length of Delta where the kth element corresponds to the coefficient for the kth relatedness coefficient, or alternatively a character in the following list: 'simple relatedness', 'double relatedness', 'first inbreeding', 'second inbreeding', 'double inbreeding'.

Delta

A list of matrices, each corresponding to a specific relatedness coefficients. Element (i,j) of matrix k corresponds to the kth estimated relatedness coefficient for the couple of individuals i and j.

Crossing

A 2-column matrix where each row corresponds to a crossing between 2 parents. Parents should be numbered.

ParentPop

A vector of numbers corresponding to population membership for the parental lines.

ShowIdentifiable

A boolean describing whether the combination should be displayed only for identifiable cases. Default value is TRUE.

Details

The function can be applied to a list of relatedness coefficients - as produced by the RelCoeff function - to compute any synthetic criterion based on a linear combination of the relatedness coefficients, for all couples. Additional information Crossing and ParentPop are required if they were used in the RelCoeff function to obtain the relatedness coefficients. The function automatically checks the identifiability of the combination to be evaluated. Several classical genetic criteria are implemented by default and can be computed using the Csuros argument. Alternatively, the user can provide a vector of coefficients to be applied through the Combination argument.

Value

If identifiability is satisfied for all pairs of individuals, all criteria are computed and returned in a matrix. If identifiability is not guaranteed for all pairs, the function will return a matrix with NA entries for the potentially non-estimable pairs. This by-default behavior can be bypassed if required by setting ShowIdentifiable to FALSE.

Author(s)

Fabien Laporte, 'UMR Genetique Quantitative et Evolution' INRA France.

References

Csuros M (2014) Non-identifiability of identity coefficients at biallelic loci. Theoretical Population Biology 92: 22-24.

Examples

require('Relatedness')
data(Delta)
RelatednessComb <- RelComb(Combination='simple relatedness', Delta, ShowIdentifiable = TRUE)
print(RelatednessComb)