-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
76 lines (58 loc) · 3.09 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# ggalign <a href="https://yunuuuu.github.io/ggalign/"><img src="man/figures/logo.png" align="right" height="139" alt="ggalign website" /></a>
<!-- badges: start -->
[](https://github.com/Yunuuuu/ggalign/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/Yunuuuu/ggalign?branch=main)
[](https://CRAN.R-project.org/package=ggalign)
<!-- badges: end -->
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](https://github.com/) with:
```{r, eval=FALSE}
# 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
- [Heatmap Layout](https://yunuuuu.github.io/ggalign/articles/layout-heatmap.html)
- [Layout Customization](https://yunuuuu.github.io/ggalign/articles/align-layout.html)
- [Layout Plot](https://yunuuuu.github.io/ggalign/articles/align-plot.html)
- [Stack Layout](https://yunuuuu.github.io/ggalign/articles/layout-stack.html)
- [Scales and Facets](https://yunuuuu.github.io/ggalign/articles/scales-and-facets.html)
## Examples
