From afb1e4789387f9c554ca4bee5b43f5e5f29248bc Mon Sep 17 00:00:00 2001 From: Yunuuuu Date: Mon, 13 Jan 2025 13:29:08 +0800 Subject: [PATCH] docs update --- README.Rmd | 130 ++++++++++++++++++++---- README.md | 284 +++++++++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 372 insertions(+), 42 deletions(-) diff --git a/README.Rmd b/README.Rmd index 2e459732..dd480ba3 100644 --- a/README.Rmd +++ b/README.Rmd @@ -75,27 +75,115 @@ remotes::install_github("Yunuuuu/ggalign") ## Compare with other similar tools -| Layout Options | `ggalign` | `ComplexHeatmap` | `marsilea` | `ggtree` | -| --------------------------------- | --------------------------------------------------- | --------------------------------- | ------------------------ | --------------------------------------------------- | -| **Language** | R | R | Python | R | -| **User Interface** | Declarative | Functional | Declarative | Declarative | -| **Plot System** | ggplot2 (Advanced plot system built on grid system) | grid | Matplotlib | ggplot2 (Advanced plot system built on grid system) | -| **Focus** | Composable Visualization | Heatmap | Composable Visualization | tree Data | -| **Quad Layout** | ✅ | Heatmap Only (discrete variables) | ✅ | ❌ | -| **Stack Layout** | ✅ | ✅ | ✅ | ❌ | -| **Circle Layout** | ✅ | ❌ | ❌ | ✅ | -| **Cross Layout** | ✅ | ❌ | ❌ | ❌ | -| **Ease of Use** | Easy for ggplot2 users | Easy for for grid user | Easy for python user | Easy for ggplot2 users | -| **Fully Compatible with ggplot2** | ✅ | ❌ | ❌ | Limited Geometric layers support | - -------------------------------------------------------------------------------- - -| Alignment | `ggalign` | `ComplexHeatmap` | `marsilea` | `ggtree` | -| --------------- | --------- | ---------------- | ---------- | -------- | -| **One-to-One** | ✅ | ✅ | ✅ | ✅ | -| **One-to-Many** | ✅ | ❌ | ❌ | ❌ | -| **Many-to-One** | ✅ | ❌ | ❌ | ❌ | -| **Cross** | ✅ | ❌ | ❌ | ❌ | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
`ggalign``marsilea``ComplexHeatmap``ggtree`
**Language**RPythonRR
**User Interface**DeclarativeDeclarativeFunctionalDeclarative
**Plot System**ggplot2 (Advanced plot system built on grid system)Matplotlibgridggplot2 (Advanced plot system built on grid system)
**Focus**Composable VisualizationComposable VisualizationHeatmaptree Data
**Quad Layout**✅✅Heatmap Only (discrete variables)❌
**Stack Layout**✅✅✅❌
**Circle Layout**✅❌❌✅
**Cross Layout**✅❌❌❌
**Alignment** **One-to-One**✅✅✅✅
**One-to-Many**✅❌❌❌
**Many-to-One**✅❌❌❌
**Cross**✅❌❌❌
**Ease of Use**Easy for ggplot2 usersEasy for python userEasy for for grid userEasy for ggplot2 users
**Fully Compatible with ggplot2**✅❌❌Limited Geometric layers support
------------------------------------------------------------------------------- diff --git a/README.md b/README.md index d43427fd..e639cd60 100644 --- a/README.md +++ b/README.md @@ -68,27 +68,269 @@ remotes::install_github("Yunuuuu/ggalign") ## Compare with other similar tools -| Layout Options | `ggalign` | `ComplexHeatmap` | `marsilea` | `ggtree` | -|-----------------------------------|-----------------------------------------------------|-----------------------------------|--------------------------|-----------------------------------------------------| -| **Language** | R | R | Python | R | -| **User Interface** | Declarative | Functional | Declarative | Declarative | -| **Plot System** | ggplot2 (Advanced plot system built on grid system) | grid | Matplotlib | ggplot2 (Advanced plot system built on grid system) | -| **Focus** | Composable Visualization | Heatmap | Composable Visualization | tree Data | -| **Quad Layout** | ✅ | Heatmap Only (discrete variables) | ✅ | ❌ | -| **Stack Layout** | ✅ | ✅ | ✅ | ❌ | -| **Circle Layout** | ✅ | ❌ | ❌ | ✅ | -| **Cross Layout** | ✅ | ❌ | ❌ | ❌ | -| **Ease of Use** | Easy for ggplot2 users | Easy for for grid user | Easy for python user | Easy for ggplot2 users | -| **Fully Compatible with ggplot2** | ✅ | ❌ | ❌ | Limited Geometric layers support | - ------------------------------------------------------------------------- - -| Alignment | `ggalign` | `ComplexHeatmap` | `marsilea` | `ggtree` | -|-----------------|-----------|------------------|------------|----------| -| **One-to-One** | ✅ | ✅ | ✅ | ✅ | -| **One-to-Many** | ✅ | ❌ | ❌ | ❌ | -| **Many-to-One** | ✅ | ❌ | ❌ | ❌ | -| **Cross** | ✅ | ❌ | ❌ | ❌ | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +`ggalign` + +`marsilea` + +`ComplexHeatmap` + +`ggtree` +
+**Language** + +R + +Python + +R + +R +
+**User Interface** + +Declarative + +Declarative + +Functional + +Declarative +
+**Plot System** + +ggplot2 (Advanced plot system built on grid system) + +Matplotlib + +grid + +ggplot2 (Advanced plot system built on grid system) +
+**Focus** + +Composable Visualization + +Composable Visualization + +Heatmap + +tree Data +
+**Quad Layout** + +✅ + +✅ + +Heatmap Only (discrete variables) + +❌ +
+**Stack Layout** + +✅ + +✅ + +✅ + +❌ +
+**Circle Layout** + +✅ + +❌ + +❌ + +✅ +
+**Cross Layout** + +✅ + +❌ + +❌ + +❌ +
+**Alignment** + +**One-to-One** + +✅ + +✅ + +✅ + +✅ +
+**One-to-Many** + +✅ + +❌ + +❌ + +❌ +
+**Many-to-One** + +✅ + +❌ + +❌ + +❌ +
+**Cross** + +✅ + +❌ + +❌ + +❌ +
+**Ease of Use** + +Easy for ggplot2 users + +Easy for python user + +Easy for for grid user + +Easy for ggplot2 users +
+**Fully Compatible with ggplot2** + +✅ + +❌ + +❌ + +Limited Geometric layers support +
------------------------------------------------------------------------