inferRelatedness: Infer Relatedness Coefficient

In R-Computing-Lab/BGMisc: An R Package for Extended Behavior Genetics Analysis

Infer Relatedness Coefficient

Description

This function infers the relatedness coefficient between two groups based on the observed correlation between their additive genetic variance and shared environmental variance.

Usage

inferRelatedness(obsR, aceA = 0.9, aceC = 0, sharedC = 0)

Arguments

obsR	Numeric. Observed correlation between the two groups. Must be between -1 and 1.
aceA	Numeric. Proportion of variance attributable to additive genetic variance. Must be between 0 and 1. Default is 0.9.
aceC	Numeric. Proportion of variance attributable to shared environmental variance. Must be between 0 and 1. Default is 0.
sharedC	Numeric. Proportion of shared environment shared between the two individuals. Must be between 0 (no shared environment) and 1 (completely shared environment). Default is 0.

Details

The function uses the ACE (Additive genetic, Common environmental, and Unique environmental) model to infer the relatedness between two individuals or groups. By considering the observed correlation ('obsR'), the proportion of variance attributable to additive genetic variance ('aceA'), and the proportion of shared environmental variance ('aceC'), it calculates the relatedness coefficient.

Value

Numeric. The calculated relatedness coefficient ('est_r').

Examples

## Not run: 
# Infer the relatedness coefficient:
inferRelatedness(obsR = 0.5, aceA = 0.9, aceC = 0, sharedC = 0)

## End(Not run)

R-Computing-Lab/BGMisc documentation built on April 3, 2025, 3:12 p.m.