From e8c674ab5b9a4df9b85e3991195ce12a445014c5 Mon Sep 17 00:00:00 2001 From: yun Date: Thu, 8 Aug 2024 19:32:24 +0800 Subject: [PATCH] update Docs --- README.Rmd | 20 ++++++++++---------- README.html | 20 ++++++++++---------- README.md | 23 +++++++++++------------ 3 files changed, 31 insertions(+), 32 deletions(-) diff --git a/README.Rmd b/README.Rmd index 4bcd4854..4ac41261 100644 --- a/README.Rmd +++ b/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. diff --git a/README.html b/README.html index 18da3182..88791d58 100644 --- a/README.html +++ b/README.html @@ -603,6 +603,13 @@ +

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 with:

@@ -614,13 +621,6 @@

Installation

pak::pkg_install(Yunuuuu/patchwork@align_axis_title).

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:

@@ -640,10 +640,10 @@

Features

  • align_reorder(): Reorder layout observations
  • align_dendro(): Reorder or Group layout based on Hierarchical Clustering
    • -
  • align_gg()/ggalign: Create ggplot object +
  • align_gg()/ggalign(): Create ggplot object in the layout
    • -
  • align_panel()/ggalign: Create ggplot -object based on the layout panel data.
    • +
  • align_panel(): Create ggplot object based on the layout +panel data.

    • See vignette("align") for details.

    Examples

    diff --git a/README.md b/README.md index 2ec6a3eb..edec4c83 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ +# 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.