Update docs

Yunuuuu · Nov 6, 2024 · 8f7dc5a · 8f7dc5a
1 parent 53445cb
commit 8f7dc5a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -73,7 +73,8 @@ remotes::install_github("Yunuuuu/ggalign")
 The usage of `ggalign` is simple if you're familiar with `ggplot2` syntax, the
 typical workflow includes: 
 
- - Initialize the layout using `ggheatmap()` or `ggstack()`.
+ - Initialize the layout using `ggheatmap()`/`ggside()`, `quad_layout()` or
+ `ggstack()`.
  - Customize the layout with:
    - `align_group()`: Group observations into panel with a group variable.
    - `align_kmeans()`: Group observations into panel by kmeans.

diff --git a/README.md b/README.md
@@ -62,7 +62,8 @@ remotes::install_github("Yunuuuu/ggalign")
 The usage of `ggalign` is simple if you’re familiar with `ggplot2`
 syntax, the typical workflow includes:
 
-- Initialize the layout using `ggheatmap()` or `ggstack()`.
+- Initialize the layout using `ggheatmap()`/`ggside()`, `quad_layout()`
+  or `ggstack()`.
 - Customize the layout with:
   - `align_group()`: Group observations into panel with a group
     variable.