update Docs

Yunuuuu · Aug 8, 2024 · 397aa7b · 397aa7b
1 parent fc67c73
commit 397aa7b
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -48,8 +48,8 @@ The documentation for `ggalign` is currently in progress.
 
 `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_group()`: Group layout axis into panel with a group variable.
+  - `align_kmeans()`: Group layout axis into panel by kmeans
   - `align_reorder()`: Reorder layout observations
   - `align_dendro()`: Reorder or Group layout based on Hierarchical Clustering
 

diff --git a/README.html b/README.html
@@ -635,8 +635,9 @@ <h2 id="features">Features</h2>
 <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
+<li><code>align_group()</code>: Group layout axis into panel with a
+group variable.</li>
+<li><code>align_kmeans()</code>: Group layout axis into panel by
 kmeans</li>
 <li><code>align_reorder()</code>: Reorder layout observations</li>
 <li><code>align_dendro()</code>: Reorder or Group layout based on

diff --git a/README.md b/README.md
@@ -39,8 +39,8 @@ The documentation for `ggalign` is currently in progress.
 
 `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_group()`: Group layout axis into panel with a group variable.
+- `align_kmeans()`: Group layout axis into panel by kmeans
 - `align_reorder()`: Reorder layout observations
 - `align_dendro()`: Reorder or Group layout based on Hierarchical
   Clustering