kinshipShift: Shifts a kinship matrix

Description Usage Arguments Details Value Author(s)

View source: R/ksGRM.R

Description

Shifts a kinship matrix

Usage

1
kinshipShift(x,shift=NULL)

Arguments

x

a square matrix

shift

the amount by which the elements of x should be shifted. if shift==NULL, the average of the off-diagonal elements is substracted

Details

The kinship matrix produced by beta.dosage is relative to the average kinship of the set of individuals analysed (1/(n(n-1)/2) ∑_i ∑_{j>i} x_{ij}=0). Another reference point might be useful, for instance to avoid negative kinship values, one might want to shift the matrix by min(x_{ij}), i \neq j.

Value

the shifted kinship matrix \frac{x-shift}{1-shift}

Author(s)

Jerome Goudet jerome.goudet@unil.ch


hierfstat documentation built on Nov. 17, 2021, 5:08 p.m.