.addTwins: Add Twins to ggplot Pedigree Plot

Description

Adds twin connections to the ggplot pedigree plot. This function modifies the `plotObject` by adding segments to represent twin relationships.

Usage

.addTwins(
  plotObject,
  connections,
  config,
  plot_connections,
  personID = "personID"
)
addTwins(
  plotObject,
  connections,
  config,
  plot_connections,
  personID = "personID"
)

Value

A ggplot object with twin segments added.

Arguments

plotObject

A ggplot object to which twin segments will be added.

connections

A data frame containing twin connection coordinates.

config

A list of configuration options for customizing the plot. See getDefaultPlotConfig for details of each option. The list can include:

code_male: Integer or string. Value identifying males in the sex column. (typically 0 or 1) Default: 1

segment_spouse_color, segment_self_color

Character. Line colors for respective connection types.

segment_sibling_color, segment_parent_color, segment_offspring_color

Character. Line colors for respective connection types.

label_text_size, point_size, segment_linewidth

Numeric. Controls text size, point size, and line thickness.

generation_height

Numeric. Vertical spacing multiplier between generations. Default: 1.

shape_unknown, shape_female, shape_male, status_shape_affected

Integers. Shape codes for plotting each group.

sex_shape_labels

Character vector of labels for the sex variable. (default: c("Female", "Male", "Unknown"))

unaffected, affected

Values indicating unaffected/affected status.

sex_color_include

Logical. If TRUE, uses color to differentiate sex.

label_max_overlaps

Maximum number of overlaps allowed in repelled labels.

label_segment_color

Color used for label connector lines.

plot_connections

A data frame containing the coordinates for twin segments.

personID

Character string specifying the column name for individual IDs. Defaults to "personID".