Skip to content

Yunuuuu/ggalign

Repository files navigation

ggalign ggalign website

R-CMD-check Codecov test coverage CRAN status

This package extends ggplot2 by providing advanced tools for aligning and organizing multiple plots, particularly those that automatically reorder observations, such as dendrogram. It offers fine control over layout adjustment and plot annotations, enabling you to create complex, publication-quality visualizations while still using the familiar grammar of ggplot2.

Why use ggalign?

ggalign focuses on aligning observations across multiple plots. It leverages the "number of observations" in the vctrs package or NROW() function to maintain consistency in plot organization.

If you’ve ever struggled with aligning plots with self-contained ordering (like dendrogram), or applying consistent grouping or ordering across multiple plots (e.g., with k-means clustering), ggalign is designed to make this easier. The package integrates seamlessly with ggplot2, providing the flexibility to use its geoms, scales, and other components for complex visualizations.

Installation

You can install ggalign from CRAN using:

install.packages("ggalign")

Alternatively, install the development version from r-universe with:

install.packages("ggalign",
    repos = c("https://yunuuuu.r-universe.dev", "https://cloud.r-project.org")
)

or from GitHub with:

# install.packages("remotes")
remotes::install_github("Yunuuuu/ggalign")

Learning ggalign

  1. The complete tutorial is available at: https://yunuuuu.github.io/ggalign-book/

  2. For the full reference documentation, visit: https://yunuuuu.github.io/ggalign/

Examples

Compare with other similar tools

ggalign marsilea aplot ComplexHeatmap
Language R Python R R
User Interface Declarative Declarative Declarative+Functional Functional
Plot System ggplot2 (Advanced plot system built on grid system) Matplotlib ggplot2 (Advanced plot system built on grid system) grid
Focus Composable Visualization Composable Visualization Composable Visualization Heatmap
StackLayout
QuadLayout Heatmap Only (discrete variables)
CircleLayout
Alignment One-to-One
One-to-Many/Many-to-One
Many-to-Many
Crosswise
Annotate observations
Fully Compatible with ggplot2

Comparison of specifications with other similar tools

Specification ggalign marsilea aplot ComplexHeatmap
Reorder observations Heatmap Only
Group observations into different panels Heatmap Only
Clustering algorithm Kmeans,Hierarchical Clustering and arbitary algorithm Kmeans,Hierarchical Clustering and arbitary algorithm
Legends Creation Automatic Manual Automatic Limited automatic, requires manual add
Legends Position Anywhere, can be controlled for a single plot Anywhere Anywhere Four sides, can only be placed on one side at a time
Dendrogram Tree from both hclust or ape hclust only Tree from both hclust or ape hclust only
Tanglegram
3D Heatmap
Oncoplot
UpSet plot

Acknowledgements

I would like to express my sincere gratitude to the contributors of the ggplot2 project for providing a powerful and flexible framework for data visualization in R. Their work laid the foundation for the functionality and design of this package. I would also like to thank the patchwork project, from which the core coding for the plot composer was adapted. The patchwork library provided a useful mechanism for combining and aligning plots, which was modified to suit the needs of this package. Without the contributions of these open-source projects, this package would not have been possible.

Additionally, I would like to extend my heartfelt thanks to @teunbrand, who has fulfilled my numerous feature requests, and assisted with the integration of new functions into ggplot2.