Skip to content

Latest commit

 

History

History
76 lines (55 loc) · 2.89 KB

README.md

File metadata and controls

76 lines (55 loc) · 2.89 KB
Raw

ggalign ggalign website

R-CMD-check Codecov test coverage CRAN status

This package extends ggplot2, enabling consistent

axis alignment across multiple plots. It’s particularly useful for plots where data order needs to be manipulated, such as aligning a dendrogram with a heatmap.

Installation

You can install ggalign from CRAN using install.packages("ggalign"). Alternatively you can install the development version of ggalign from GitHub with:

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

Overviews

ggalign pacakge provides two layout to arrange ggplot objects:

  • layout_heatmap()/ggheatmap(): Arrange ggplot into a Heatmap layout. See vignette("layout-heatmap") for details.

  • layout_stack()/ggstack(): Arrange ggplot vertically or horizontally. See vignette("layout-stack") for details.

To further customize these layouts, we offer following functions:

  • align_group(): Group layout axis into panel with a group variable.
  • align_kmeans(): Group layout axis into panel by kmeans
  • align_reorder(): Reorders layout observations based on weights or summary statistics.
  • align_dendro(): Reorder or Group layout based on hierarchical clustering

For more detailed instructions on customizing layouts, see the vignette: vignette("align-layout").

Additionally, plots can be added in the layout with following functions:

  • align_gg()/ggalign(): Create ggplot object with a customized data.
  • align_panel()/ggpanel(): Create ggplot object with the layout panel data.

For more information on adding plots, refer to the vignette: vignette("align-plot").

Documentation

Examples