optimizePedigree

Optimize a pedigree plot by rounding coordinates to reduce file size.

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'

optimizePedigree function

<dl><dt>p</dt>
<dd>A plotly or ggplot object representing the pedigree plot.</dd>
<dt>config</dt>
<dd>A list of configuration parameters, including `value_rounding_digits`.</dd>
<dt>plot_type</dt>
<dd>A string indicating the type of plot: "plotly" or
"static". Default is "plotly".
@return The optimized plot object with rounded coordinates.
@keywords internal</dd></dl>

Arguments

Optimize Pedigree Plot — optimizePedigree

<dl>

<dt>p</dt>
<dd>A plotly or ggplot object representing the pedigree plot.</dd>


<dt>config</dt>
<dd>A list of configuration parameters, including `value_rounding_digits`.</dd>


<dt>plot_type</dt>
<dd>A string indicating the type of plot: "plotly" or
"static". Default is "plotly".
@return The optimized plot object with rounded coordinates.
@keywords internal</dd>

</dl>

optimizePedigree: Optimize Pedigree Plot

Description

Usage

Arguments