ggPedigree.core {ggpedigree} | R Documentation |
Core Function for ggPedigree
Description
This function is the core implementation of the ggPedigree function. It handles the data preparation, layout calculation, and plotting of the pedigree diagram. It is not intended to be called directly by users.
Usage
ggPedigree.core(
ped,
famID = "famID",
personID = "personID",
momID = "momID",
dadID = "dadID",
spouseID = "spouseID",
matID = "matID",
patID = "patID",
twinID = "twinID",
focal_fill_column = NULL,
overlay_column = NULL,
status_column = NULL,
config = list(),
debug = FALSE,
hints = NULL,
function_name = "ggPedigree",
phantoms = FALSE,
...
)
Arguments
ped |
A data frame containing the pedigree data. Needs personID, momID, and dadID columns |
famID |
Character string specifying the column name for family IDs. Defaults to "famID". |
personID |
Character string specifying the column name for individual IDs. Defaults to "personID". |
momID |
Character string specifying the column name for mother IDs. Defaults to "momID". |
dadID |
Character string specifying the column name for father IDs. Defaults to "dadID". |
spouseID |
Character string specifying the column name for spouse IDs. Defaults to "spouseID". |
matID |
Character string specifying the column name for maternal lines Defaults to "matID". |
patID |
Character string specifying the column name for paternal lines Defaults to "patID". |
twinID |
Character string specifying the column name for twin IDs. Defaults to "twinID". |
focal_fill_column |
Character string specifying the column name for focal fill color. |
overlay_column |
Character string specifying the column name for overlay alpha values. |
status_column |
Character string specifying the column name for affected status. Defaults to NULL. |
config |
A list of configuration options for customizing the plot. See getDefaultPlotConfig for details. The list can include:
|
debug |
Logical. If TRUE, prints debugging information. Default: FALSE. |
hints |
Data frame with hints for layout adjustments. Default: NULL. |
phantoms |
Logical. If TRUE, adds phantom parents for individuals without parents. |
... |
Additional arguments passed to 'ggplot2' functions. |