Skip to contents

ggpedigree

ggpedigree provides modern tools for visualizing family trees and pedigree structures using both ggplot2 and plotly. Specifically, it enables the creation of static and interactive pedigree plots that can accommodate complex family relationships, including duplicated individuals and various mating structures.

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.

Installation

You can install the released version of ggpedigree from CRAN with:

install.packages("ggpedigree")

To install the development version of ggpedigree from GitHub use:

# install.packages("devtools")
devtools::install_github("R-Computing-Lab/ggpedigree")

Demonstration

Here is a basic example of how to use ggpedigree to visualize a pedigree structure. The potter dataset contains simulated pedigree data for the Weasley family from the Harry Potter series.

library(ggpedigree) # ggPedigree lives here
library(BGmisc) # helper utilities & example data
potter <- BGmisc::potter # load example data
ggPedigree(potter,
  famID = "famID",
  personID = "personID"
)

ggPedigree(potter,
  famID = "famID",
  personID = "personID",
  config = list(
    color_theme = "greyscale")
)

Citation

If you use ggpedigree in your research or wish to refer to it, please cite the following:

citation(package = "ggpedigree")

Garrison S (2026). ggpedigree: Visualizing Pedigrees with ‘ggplot2’ and ‘plotly’. R package version 1.1.0.2, https://github.com/R-Computing-Lab/ggpedigree/.

A BibTeX entry for LaTeX users is

@Manual{,
  title = {ggpedigree: Visualizing Pedigrees with 'ggplot2' and 'plotly'},
  author = {S. Mason Garrison},
  year = {2026},
  note = {R package version 1.1.0.2},
  url = {https://github.com/R-Computing-Lab/ggpedigree/},
}

Contributing

Contributions to the ggpedigree project are welcome. For guidelines on how to contribute, please refer to the Contributing Guidelines. Issues and pull requests should be submitted on the GitHub repository. For support, please use the GitHub issues page.

Branching and Versioning System

The development of ggpedigree follows a GitFlow branching strategy:

  • Feature Branches: All major changes and new features should be developed on separate branches created from the dev branch. Name these branches according to the feature or change they are meant to address.
  • Development Branch: The dev branch is the main development branch where all feature branches are merged. This branch contains the latest changes and is used for testing and development purposes.
  • Main Branch (main): The main branch mirrors the stable state of the project as seen on CRAN. Only fully tested and approved changes from the dev branch are merged into main to prepare for a new release.

License

ggpedigree is licensed under the GNU General Public License v3.0. For more details, see the LICENSE.md file.