Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
Yunuuuu committed Aug 8, 2024
1 parent 2f32b44 commit 68458ea
Showing 3 changed files with 14 additions and 7 deletions.
6 changes: 4 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -46,13 +46,15 @@ The documentation for `ggalign` is currently in progress.
- `layout_stack()`/`ggstack()`: Arrange ggplot vertically or horizontally. See
`vignette("layout-stack")` for details.

`ggalign` provides `Align` objects to reordering or set panels for layout, in
addition, `Align` objects can also add plot into the layout:
`ggalign` provides `Align` objects to reorder or set panels for layout:

- `align_group()`: Group layout axis into panel
- `align_kmeans()`: Group layout observations by kmeans
- `align_reorder()`: Reorder layout observations
- `align_dendro()`: Reorder or Group layout based on Hierarchical Clustering

In addition, `Align` objects can also add plot into the layout:

- `align_gg()`/`ggalign()`: Create ggplot object in the layout
- `align_panel()`/`ggpanel()`: Create ggplot object based on the layout panel
data.
9 changes: 6 additions & 3 deletions README.html
Original file line number Diff line number Diff line change
@@ -632,16 +632,19 @@ <h2 id="features">Features</h2>
ggplot vertically or horizontally. See
<code>vignette(&quot;layout-stack&quot;)</code> for details.</p></li>
</ul>
<p><code>ggalign</code> provides <code>Align</code> objects to
reordering or set panels for layout, in addition, <code>Align</code>
objects can also add plot into the layout:</p>
<p><code>ggalign</code> provides <code>Align</code> objects to reorder
or set panels for layout:</p>
<ul>
<li><code>align_group()</code>: Group layout axis into panel</li>
<li><code>align_kmeans()</code>: Group layout observations by
kmeans</li>
<li><code>align_reorder()</code>: Reorder layout observations</li>
<li><code>align_dendro()</code>: Reorder or Group layout based on
Hierarchical Clustering</li>
</ul>
<p>In addition, <code>Align</code> objects can also add plot into the
layout:</p>
<ul>
<li><code>align_gg()</code>/<code>ggalign()</code>: Create ggplot object
in the layout</li>
<li><code>align_panel()</code>/<code>ggpanel()</code>: Create ggplot
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -37,14 +37,16 @@ The documentation for `ggalign` is currently in progress.
- `layout_stack()`/`ggstack()`: Arrange ggplot vertically or
horizontally. See `vignette("layout-stack")` for details.

`ggalign` provides `Align` objects to reordering or set panels for
layout, in addition, `Align` objects can also add plot into the layout:
`ggalign` provides `Align` objects to reorder or set panels for layout:

- `align_group()`: Group layout axis into panel
- `align_kmeans()`: Group layout observations by kmeans
- `align_reorder()`: Reorder layout observations
- `align_dendro()`: Reorder or Group layout based on Hierarchical
Clustering

In addition, `Align` objects can also add plot into the layout:

- `align_gg()`/`ggalign()`: Create ggplot object in the layout
- `align_panel()`/`ggpanel()`: Create ggplot object based on the layout
panel data.

0 comments on commit 68458ea

Please sign in to comment.