update Docs

README.Rmd

@@ -13,6 +13,14 @@ knitr::opts_chunk$set(
 )
 ```
 
+# ggalign
+This package extends ggplot2 and provides numerous benefits for organizing and
+arranging plots. It is specifically designed to align a specific axis of
+multiple ggplot objects in a consistent order. This functionality is
+particularly useful for plots that require manipulation of data order. A common
+plot combination that can be effectively organized using this package includes a
+dendrogram and a heatmap.
+
 ## Installation
 
 You can install the development version of `ggalign` from [GitHub](https://github.com/) with:
@@ -29,14 +37,6 @@ should install patchwork with
 
 The documentation for `ggalign` is currently in progress.
 
-# ggalign
-This package extends ggplot2 and provides numerous benefits for organizing and
-arranging plots. It is specifically designed to align a specific axis of
-multiple ggplot objects in a consistent order. This functionality is
-particularly useful for plots that require manipulation of data order. A common
-plot combination that can be effectively organized using this package includes a
-dendrogram and a heatmap.
-
 ## Features
 `ggalign` provides two layout to arrange ggplot objects:
 
@@ -53,8 +53,8 @@ addition, `Align` objects can also add plot into the layout:
   - `align_kmeans()`: Group layout observations by kmeans
   - `align_reorder()`: Reorder layout observations
   - `align_dendro()`: Reorder or Group layout based on Hierarchical Clustering
-  - `align_gg()`/`ggalign`: Create ggplot object in the layout
-  - `align_panel()`/`ggalign`: Create ggplot object based on the layout panel data.
+  - `align_gg()`/`ggalign()`: Create ggplot object in the layout
+  - `align_panel()`: Create ggplot object based on the layout panel data.
 
 See `vignette("align")` for details.
 

README.html

@@ -603,6 +603,13 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
+<h1 id="ggalign">ggalign</h1>
+<p>This package extends ggplot2 and provides numerous benefits for
+organizing and arranging plots. It is specifically designed to align a
+specific axis of multiple ggplot objects in a consistent order. This
+functionality is particularly useful for plots that require manipulation
+of data order. A common plot combination that can be effectively
+organized using this package includes a dendrogram and a heatmap.</p>
 <h2 id="installation">Installation</h2>
 <p>You can install the development version of <code>ggalign</code> from
 <a href="https://github.com/">GitHub</a> with:</p>
@@ -614,13 +621,6 @@ <h2 id="installation">Installation</h2>
 <code>pak::pkg_install(Yunuuuu/patchwork@align_axis_title)</code>.</p>
 <p>The documentation for <code>ggalign</code> is currently in
 progress.</p>
-<h1 id="ggalign">ggalign</h1>
-<p>This package extends ggplot2 and provides numerous benefits for
-organizing and arranging plots. It is specifically designed to align a
-specific axis of multiple ggplot objects in a consistent order. This
-functionality is particularly useful for plots that require manipulation
-of data order. A common plot combination that can be effectively
-organized using this package includes a dendrogram and a heatmap.</p>
 <h2 id="features">Features</h2>
 <p><code>ggalign</code> provides two layout to arrange ggplot
 objects:</p>
@@ -640,10 +640,10 @@ <h2 id="features">Features</h2>
 <li><code>align_reorder()</code>: Reorder layout observations</li>
 <li><code>align_dendro()</code>: Reorder or Group layout based on
 Hierarchical Clustering</li>
-<li><code>align_gg()</code>/<code>ggalign</code>: Create ggplot object
+<li><code>align_gg()</code>/<code>ggalign()</code>: Create ggplot object
 in the layout</li>
-<li><code>align_panel()</code>/<code>ggalign</code>: Create ggplot
-object based on the layout panel data.</li>
+<li><code>align_panel()</code>: Create ggplot object based on the layout
+panel data.</li>
 </ul>
 <p>See <code>vignette(&quot;align&quot;)</code> for details.</p>
 <h2 id="examples">Examples</h2>

README.md

@@ -1,6 +1,15 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
+# ggalign
+
+This package extends ggplot2 and provides numerous benefits for
+organizing and arranging plots. It is specifically designed to align a
+specific axis of multiple ggplot objects in a consistent order. This
+functionality is particularly useful for plots that require manipulation
+of data order. A common plot combination that can be effectively
+organized using this package includes a dendrogram and a heatmap.
+
 ## Installation
 
 You can install the development version of `ggalign` from
@@ -18,15 +27,6 @@ try it, you should install patchwork with
 
 The documentation for `ggalign` is currently in progress.
 
-# ggalign
-
-This package extends ggplot2 and provides numerous benefits for
-organizing and arranging plots. It is specifically designed to align a
-specific axis of multiple ggplot objects in a consistent order. This
-functionality is particularly useful for plots that require manipulation
-of data order. A common plot combination that can be effectively
-organized using this package includes a dendrogram and a heatmap.
-
 ## Features
 
 `ggalign` provides two layout to arrange ggplot objects:
@@ -45,9 +45,8 @@ layout, in addition, `Align` objects can also add plot into the layout:
 - `align_reorder()`: Reorder layout observations
 - `align_dendro()`: Reorder or Group layout based on Hierarchical
   Clustering
-- `align_gg()`/`ggalign`: Create ggplot object in the layout
-- `align_panel()`/`ggalign`: Create ggplot object based on the layout
-  panel data.
+- `align_gg()`/`ggalign()`: Create ggplot object in the layout
+- `align_panel()`: Create ggplot object based on the layout panel data.
 
 See `vignette("align")` for details.