buildSpouseSegments

internal

Provides plotting functions for visualizing pedigrees and family trees. The package complements a behavior genetics package 'BGmisc' [Garrison et al. (2024) <doi:10.21105/joss.06203>] by rendering pedigrees using the 'ggplot2' framework. Features include support for duplicated individuals, complex mating structures, integration with simulated pedigrees, and layout customization. Due to the impending deprecation of kinship2, version 1.0 incorporates the layout helper functions from kinship2. The pedigree alignment algorithms are adapted from 'kinship2' [Sinnwell et al. (2014) <doi:10.1159/000363105>]. We gratefully acknowledge the original authors: Jason Sinnwell, Terry Therneau, Daniel Schaid, and Elizabeth Atkinson for their foundational work.

S. Mason Garrison

ggpedigree

Visualizing Pedigrees with 'ggplot2' and 'plotly'

buildSpouseSegments function

<dl><dt>ped</dt>
<dd>A data frame containing the pedigree data. Needs personID, momID, dadID, and sex columns.</dd>
<dt>connections_for_FOO</dt>
<dd>A data frame containing the connections for the spouse segments from parent connections</dd>
<dt>use_hash</dt>
<dd>Logical. If TRUE, use the parent_hash to build segments. If FALSE, use the spouseID.</dd></dl>

Arguments

Build spouse segments — buildSpouseSegments

<dl>

<dt>ped</dt>
<dd>A data frame containing the pedigree data. Needs personID, momID, dadID, and sex columns.</dd>


<dt>connections_for_FOO</dt>
<dd>A data frame containing the connections for the spouse segments from parent connections</dd>


<dt>use_hash</dt>
<dd>Logical. If TRUE, use the parent_hash to build segments. If FALSE, use the spouseID.</dd>

</dl>

buildSpouseSegments: Build spouse segments

Description

Usage

Value

Arguments