Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
Yunuuuu committed Mar 5, 2025
1 parent 8173a32 commit 4c4bac4
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 15 deletions.
9 changes: 5 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ Authors@R: c(
person("Shixiang", "Wang", , "[email protected]", role = "aut", comment = c(ORCID = "0000-0001-9855-7357")),
person("Guangchuang", "Yu", email = "[email protected]", role = "aut", comment = c(ORCID = "0000-0002-6485-8781"))
)
Description: A 'ggplot2' extension offers various tools for organizing and arranging plots.
It is designed to consistently align a specific axis across multiple 'ggplot' objects,
making it especially useful for plots requiring data order manipulation. A typical use
case includes organizing combinations like a dendrogram and a heatmap.
Description: A 'ggplot2' extension offers various tools the creation of complex,
multi-plot visualizations. It is designed to consistently align a specific
axis across multiple 'ggplot' objects, making it especially useful for plots
requiring data order manipulation. A typical use case includes organizing
combinations like a dendrogram and a heatmap.
License: MIT + file LICENSE
URL: https://github.com/Yunuuuu/ggalign, https://yunuuuu.github.io/ggalign/
BugReports: https://github.com/Yunuuuu/ggalign/issues
Expand Down
13 changes: 8 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,14 @@ url <- params[["book"]]
[![DOI](https://zenodo.org/badge/828195668.svg)](https://doi.org/10.5281/zenodo.14825328)
<!-- badges: end -->

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.
The `ggalign` package extends `ggplot2` to simplify the creation of complex,
multi-plot visualizations, especially for biomedical research. Built on the
familiar grammar of graphics, it provides intuitive tools to align and organize
plots—such as heatmaps, dendrograms, or circular layouts—while handling
intricate relationships in multi-omics data, like genomics or microbiomes.
Whether you need to stack plots, arrange them around a central figure, or link
diverse datasets (e.g., genes to pathways), `ggalign` offers flexibility and
precision with minimal effort.

## Why use `ggalign`?
`ggalign` focuses on aligning observations across multiple plots. If you've ever
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,15 @@ status](https://www.r-pkg.org/badges/version/ggalign)](https://CRAN.R-project.or
[![DOI](https://zenodo.org/badge/828195668.svg)](https://doi.org/10.5281/zenodo.14825328)
<!-- badges: end -->

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.
The `ggalign` package extends `ggplot2` to simplify the creation of
complex, multi-plot visualizations, especially for biomedical research.
Built on the familiar grammar of graphics, it provides intuitive tools
to align and organize plots—such as heatmaps, dendrograms, or circular
layouts—while handling intricate relationships in multi-omics data, like
genomics or microbiomes. Whether you need to stack plots, arrange them
around a central figure, or link diverse datasets (e.g., genes to
pathways), `ggalign` offers flexibility and precision with minimal
effort.

## Why use `ggalign`?

Expand Down

0 comments on commit 4c4bac4

Please sign in to comment.