ggRelatednessMatrix.core

This function is the core implementation of the ggRelatednessMatrix function.
It handles the data preparation, layout calculation,
and plotting of the pedigree diagram.
It is not intended to be called directly by users.

internal

Provides plotting functions for visualizing pedigrees in behavior genetics and kinship research. The package complements 'BGmisc' [Garrison et al. (2024) <doi:10.21105/joss.06203>] by rendering pedigrees using the 'ggplot2' framework and offers a modern alternative to the base-graphics pedigree plot in 'kinship2' [Sinnwell et al. (2014) <doi:10.1159/000363105>]. Features include support for duplicated individuals, complex mating structures, integration with simulated pedigrees, and layout customization.

S. Mason Garrison

ggpedigree

Visualizing Pedigrees with 'ggplot2' and 'plotly'

ggRelatednessMatrix.core function

<dl><dt>mat</dt>
<dd>A square numeric matrix of relatedness values (precomputed, e.g., from ped2add).</dd>
<dt>config</dt>
<dd>A list of graphical and display parameters.
See Details for available options.</dd>
<dt>...</dt>
<dd>Additional arguments passed to ggplot2 layers.</dd></dl>

Arguments

Core Function for ggRelatednessMatrix — ggRelatednessMatrix.core

<dl>

<dt>mat</dt>
<dd>A square numeric matrix of relatedness values (precomputed, e.g., from ped2add).</dd>


<dt>config</dt>
<dd>A list of graphical and display parameters.
See Details for available options.</dd>


<dt>...</dt>
<dd>Additional arguments passed to ggplot2 layers.</dd>

</dl>

ggRelatednessMatrix.core: Core Function for ggRelatednessMatrix

Description

Usage

Arguments