ggPedigreeInteractive {ggpedigree} | R Documentation |
Interactive pedigree plot (Plotly wrapper around ggPedigree)
Description
Generates an interactive HTML widget built on top of the static ggPedigree output. All layout, styling, and connection logic are inherited from ggPedigree(); this function simply augments the plot with Plotly hover, zoom, and pan functionality.
Usage
ggPedigreeInteractive(
ped,
famID = "famID",
personID = "personID",
momID = "momID",
dadID = "dadID",
patID = "patID",
matID = "matID",
twinID = "twinID",
status_column = NULL,
tooltip_columns = NULL,
focal_fill_column = NULL,
overlay_column = NULL,
config = list(),
debug = FALSE,
return_widget = TRUE,
phantoms = FALSE,
...
)
ggpedigreeinteractive(
ped,
famID = "famID",
personID = "personID",
momID = "momID",
dadID = "dadID",
patID = "patID",
matID = "matID",
twinID = "twinID",
status_column = NULL,
tooltip_columns = NULL,
focal_fill_column = NULL,
overlay_column = NULL,
config = list(),
debug = FALSE,
return_widget = TRUE,
phantoms = FALSE,
...
)
ggpedigreeInteractive(
ped,
famID = "famID",
personID = "personID",
momID = "momID",
dadID = "dadID",
patID = "patID",
matID = "matID",
twinID = "twinID",
status_column = NULL,
tooltip_columns = NULL,
focal_fill_column = NULL,
overlay_column = NULL,
config = list(),
debug = FALSE,
return_widget = TRUE,
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". |
patID |
Character string specifying the column name for paternal lines Defaults to "patID". |
matID |
Character string specifying the column name for maternal lines Defaults to "matID". |
twinID |
Character string specifying the column name for twin IDs. Defaults to "twinID". |
status_column |
Character string specifying the column name for affected status. Defaults to NULL. |
tooltip_columns |
Character vector of column names to show when hovering. Defaults to c("personID", "sex"). Additional columns present in 'ped' can be supplied – they will be added to the Plotly tooltip text. Defaults to NULL, which uses the default tooltip columns. |
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. |
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. |
return_widget |
Logical; if TRUE (default) returns a plotly htmlwidget. If FALSE, returns the underlying plotly object (useful for further customization before printing). |
phantoms |
Logical. If TRUE, adds phantom parents for individuals without parents. |
... |
Additional arguments passed to 'ggplot2' functions. |
Value
A plotly htmlwidget (or plotly object if 'return_widget = FALSE').
Examples
library(BGmisc)
data("potter")
ggPedigreeInteractive(potter, famID = "famID", personID = "personID")