.addLabels

Add Labels to ggplot Pedigree Plot

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'

.addLabels function

<dl><dt>p</dt>
<dd>A ggplot object.</dd>
<dt>config</dt>
<dd>A list of configuration options for customizing the plot.
 See getDefaultPlotConfig for details. The list can include:<dl>
 <dt>code_male</dt>
<dd>Integer or string. Value identifying males in the sex column. (typically 0 or 1) Default: 1.</dd></dl></dd> <dt>segment_spouse_color, segment_self_color</dt>
<dd>Character. Line colors for respective connection types.</dd> <dt>segment_sibling_color, segment_parent_color, segment_offspring_color</dt>
<dd>Character. Line colors for respective connection types.</dd> <dt>label_text_size, point_size, segment_linewidth</dt>
<dd>Numeric. Controls text size, point size, and line thickness.</dd> <dt>generation_height</dt>
<dd>Numeric. Vertical spacing multiplier between generations. Default: 1.</dd> <dt>shape_unknown, shape_female, shape_male, status_shape_affected</dt>
<dd>Integers. Shape codes for plotting each group.</dd> <dt>sex_shape_labels</dt>
<dd>Character vector of labels for the sex variable. (default: c("Female", "Male", "Unknown"))</dd> <dt>unaffected, affected</dt>
<dd>Values indicating unaffected/affected status.</dd> <dt>sex_color_include</dt>
<dd>Logical. If TRUE, uses color to differentiate sex.</dd> <dt>label_max_overlaps</dt>
<dd>Maximum number of overlaps allowed in repelled labels.</dd> <dt>label_segment_color</dt>
<dd>Color used for label connector lines.</dd> 
</dl>

Arguments

Add Labels to ggplot Pedigree Plot — .addLabels

<dl>

<dt>p</dt>
<dd>A ggplot object.</dd>


<dt>config</dt>
<dd>A list of configuration options for customizing the plot.
 See getDefaultPlotConfig for details. The list can include:<dl>
 <dt>code_male</dt>
<dd>Integer or string. Value identifying males in the sex column. (typically 0 or 1) Default: 1.</dd>

 <dt>segment_spouse_color, segment_self_color</dt>
<dd>Character. Line colors for respective connection types.</dd>

 <dt>segment_sibling_color, segment_parent_color, segment_offspring_color</dt>
<dd>Character. Line colors for respective connection types.</dd>

 <dt>label_text_size, point_size, segment_linewidth</dt>
<dd>Numeric. Controls text size, point size, and line thickness.</dd>

 <dt>generation_height</dt>
<dd>Numeric. Vertical spacing multiplier between generations. Default: 1.</dd>

 <dt>shape_unknown, shape_female, shape_male, status_shape_affected</dt>
<dd>Integers. Shape codes for plotting each group.</dd>

 <dt>sex_shape_labels</dt>
<dd>Character vector of labels for the sex variable. (default: c("Female", "Male", "Unknown"))</dd>

 <dt>unaffected, affected</dt>
<dd>Values indicating unaffected/affected status.</dd>

 <dt>sex_color_include</dt>
<dd>Logical. If TRUE, uses color to differentiate sex.</dd>

 <dt>label_max_overlaps</dt>
<dd>Maximum number of overlaps allowed in repelled labels.</dd>

 <dt>label_segment_color</dt>
<dd>Color used for label connector lines.</dd>

 
</dl></dd>

</dl>

.addLabels: Add Labels to ggplot Pedigree Plot

Description

Usage

Value

Arguments