ggpedigree

This is companion package to BGmisc for ggplot2

https://github.com/r-computing-lab/ggpedigree

Repository

This is companion package to BGmisc for ggplot2

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
options(citation.bibtex.max = 0)
```

# ggpedigree



[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![CRAN version](https://www.r-pkg.org/badges/version/ggpedigree)](https://CRAN.R-project.org/package=ggpedigree)
[![CRAN checks](https://badges.cranchecks.info/worst/ggpedigree.svg)](https://cran.r-project.org/web/checks/check_results_ggpedigree.html)
[![Package downloads](https://cranlogs.r-pkg.org/badges/grand-total/ggpedigree)](https://cranlogs.r-pkg.org/badges/grand-total/ggpedigree)
[![codecov](https://codecov.io/gh/R-Computing-Lab/ggpedigree/branch/main/graph/badge.svg?token=xXWYDcD9CF)](https://app.codecov.io/gh/R-Computing-Lab/ggpedigree)

[![R-CMD-check](https://github.com/R-Computing-Lab/ggpedigree/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/R-Computing-Lab/ggpedigree/actions/workflows/R-CMD-check.yaml)
[![Dev branch](https://github.com/R-Computing-Lab/ggpedigree/actions/workflows/R-CMD-devcheck.yaml/badge.svg)](https://github.com/R-Computing-Lab/ggpedigree/actions/workflows/R-CMD-devcheck.yaml)
[![Website Deployed](https://github.com/R-Computing-Lab/ggpedigree/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/R-Computing-Lab/ggpedigree/actions/workflows/pkgdown.yaml)
[![License](https://img.shields.io/badge/License-GPL_v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
[![status](https://joss.theoj.org/papers/e5116b83b03e2740960d1153c45f9480/status.svg)](https://joss.theoj.org/papers/e5116b83b03e2740960d1153c45f9480)




`ggpedigree` provides modern tools for visualizing pedigree structures using both 'ggplot2' and 'plotly'. It is designed to work seamlessly with the `BGmisc` package for simulated or empirical pedigree data, and extends the plotting capabilities of the base-graphics functions in `kinship2`.

The package supports:

- Static, publication-ready pedigree plots using the `ggplot2` framework

- Interactive pedigree visualizations using `plotly`

- Layout customization, complex mating structures, and duplicated individuals

`ggpedigree` is useful in behavior genetics, kinship analysis, and any research involving complex pedigree data.

## Installation

You can install the released version of ggpedigree from [CRAN](https://cran.r-project.org/) with:

```r
install.packages("ggpedigree")
```

To install the development version of `ggpedigree` from [GitHub](https://github.com/) use:

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

## Demonstration

```{r load-data, include=FALSE}
library(ggpedigree) # ggPedigree lives here
library(BGmisc) # helper utilities & example data
library(tidyverse)
# if you don't have the most recent version of BGmisc, you may need to install it first as a stop-gap I've added the data loading here
data("potter") # load example data from BGmisc
if (!"twinID" %in% names(potter)) {
  # Add twinID and zygosity columns for demonstration purposes
  potter <- potter %>%
    mutate(
      twinID = case_when(
        name == "Fred Weasley" ~ 13,
        name == "George Weasley" ~ 12,
        TRUE ~ NA_real_
      ),
      zygosity = case_when(
        name == "Fred Weasley" ~ "mz",
        name == "George Weasley" ~ "mz",
        TRUE ~ NA_character_
      )
    )
}
```

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.

```{r basic-usage,out.width = "80%"}
ggPedigree(potter,
  famID = "famID",
  personID = "personID"
)
```



## Citation

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

```
citation(package = "ggpedigree")
```

```{r,comment='',results='asis',echo=FALSE} 
print(citation(package = "ggpedigree"), style = "text", bibtex = FALSE)
```

A BibTeX entry for LaTeX users is
```{r,comment='',echo=FALSE}
toBibtex(citation(package = "ggpedigree"))
```

## Contributing

Contributions to the ggpedigree project are welcome. For guidelines on how to contribute, please refer to the [Contributing Guidelines](https://github.com/R-Computing-Lab/ggpedigree/blob/main/CONTRIBUTING.md). 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](https://tilburgsciencehub.com/topics/automation/version-control/advanced-git/git-branching-strategies/):

- **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](https://github.com/R-Computing-Lab/ggpedigree/blob/main/LICENSE.md) file.

Owner

JOSS Publication

ggpedigree: Visualizing Pedigrees with 'ggplot2' and 'plotly'

Published

February 01, 2026

DOI

10.21105/joss.09434

Volume 11, Issue 118, Page 9434

Authors

S. Mason Garrison
Department of Psychology, Wake Forest University, North Carolina, USA

Editor

Charlotte Soneson

Tags

pedigrees family trees quantitative genetics behavior genetics visualization ggplot2 plotly

View PDF Review Thread Software Archive

GitHub Events

Issues and Pull Requests

Last synced: 10 months ago

Packages