kinship2_check.hint

This function checks the consistency of kinship2 hints, particularly
focusing on the `order` and `spouse` components. It ensures that the
order is numeric and matches the length of the `sex` vector, and that
marriages are valid male/female pairs without duplicates.

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'

kinship2_check.hint function

<dl><dt>hints</dt>
<dd>A list containing kinship2 hints, including `order` and optionally `spouse`.</dd>
<dt>sex</dt>
<dd>A character vector indicating the sex of each individual
('male' or 'female').</dd></dl>

Arguments

Check kinship2 hints for consistency — kinship2_check.hint

<dl>

<dt>hints</dt>
<dd>A list containing kinship2 hints, including `order` and optionally `spouse`.</dd>


<dt>sex</dt>
<dd>A character vector indicating the sex of each individual
('male' or 'female').</dd>

</dl>

kinship2_check.hint: Check kinship2 hints for consistency

Description

Usage

Value

Arguments

Details