Skip to content

Commit

Permalink
update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Yunuuuu committed Jun 22, 2024
1 parent 508293f commit ad38824
Show file tree
Hide file tree
Showing 37 changed files with 70 additions and 37 deletions.
49 changes: 30 additions & 19 deletions README.html

Large diffs are not rendered by default.

31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

- [eheat](#eheat)
- [Installation](#installation)
- [ggheat](#ggheat)
- [gganno](#gganno)
- [`ggheat`](#ggheat)
- [`gganno`](#gganno)
- [`anno_gg` and `anno_gg2`](#anno_gg-and-anno_gg2)

<!-- README.md is generated from README.Rmd. Please edit that file -->
Expand Down Expand Up @@ -109,7 +109,7 @@ ComplexHeatmap is the ease of plotting statistical annotations. Another
benefit is that the legends can be internally extracted from the ggplot2
plot, eliminating the need for manual addition of legends.

## ggheat
## `ggheat`

Using `ggheat`, it is effortless to create a simple Heatmap. The default
color mapping was not consistent between ComplexHeatmap and ggplot2.
Expand Down Expand Up @@ -344,7 +344,7 @@ draw(

<img src="man/figures/README-ggheat_legend_name2-1.png" width="100%" />

## gganno
## `gganno`

The same with `ggheat`, the essential parameter of `gganno` is also the
`ggfn`, which accepts a ggplot2 object equipped with a default data and
Expand Down Expand Up @@ -620,7 +620,7 @@ ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "panel",
margins = NULL,
height = unit(6, "cm"),
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand All @@ -635,7 +635,7 @@ ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "panel",
margins = "l",
height = unit(6, "cm"),
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand All @@ -650,7 +650,7 @@ ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "panel",
margins = "r",
height = unit(6, "cm"),
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand All @@ -664,7 +664,7 @@ ggheat(m,
ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "plot",
height = unit(6, "cm"),
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand All @@ -677,8 +677,19 @@ ggheat(m,
# anno_gg2-full --------------------
ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "full",
height = unit(6, "cm"),
ggplot = anno_gg2(
g + guides(colour = guide_legend(
theme = theme(
legend.key.size = unit(1, "mm"),
legend.text = element_text(size = 10),
legend.key.spacing = unit(0, "mm"),
legend.title.position = "bottom",
legend.key = element_blank()
),
ncol = 2L
)),
align_with = "full",
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand Down
Binary file modified man/figures/README-anno_gg2-full-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-anno_gg2-panel1-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-anno_gg2-panel2-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-anno_gg2-panel3-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-anno_gg2-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 19 additions & 8 deletions vignettes/eheat.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ ggplot2 in ComplexHeatmap is the ease of plotting statistical annotations.
Another benefit is that the legends can be internally extracted from the ggplot2
plot, eliminating the need for manual addition of legends.

## ggheat
## `ggheat`
Using `ggheat`, it is effortless to create a simple Heatmap. The default color
mapping was not consistent between ComplexHeatmap and ggplot2.

Expand Down Expand Up @@ -261,7 +261,7 @@ draw(
)
```

## gganno
## `gganno`
The same with `ggheat`, the essential parameter of `gganno` is also the `ggfn`,
which accepts a ggplot2 object equipped with a default data and mappings
established by `ggplot(data, aes(.data$.x (or .data$.y)))`. The original matrix
Expand Down Expand Up @@ -497,7 +497,7 @@ ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "panel",
margins = NULL,
height = unit(6, "cm"),
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand All @@ -510,7 +510,7 @@ ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "panel",
margins = "l",
height = unit(6, "cm"),
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand All @@ -523,7 +523,7 @@ ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "panel",
margins = "r",
height = unit(6, "cm"),
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand All @@ -535,7 +535,7 @@ ggheat(m,
ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "plot",
height = unit(6, "cm"),
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand All @@ -546,8 +546,19 @@ ggheat(m,
# anno_gg2-full --------------------
ggheat(m,
top_annotation = HeatmapAnnotation(
ggplot = anno_gg2(g, "full",
height = unit(6, "cm"),
ggplot = anno_gg2(
g + guides(colour = guide_legend(
theme = theme(
legend.key.size = unit(1, "mm"),
legend.text = element_text(size = 10),
legend.key.spacing = unit(0, "mm"),
legend.title.position = "bottom",
legend.key = element_blank()
),
ncol = 2L
)),
align_with = "full",
height = unit(3, "cm"),
show_name = FALSE
)
)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vignettes/eheat_files/figure-html/anno_bar-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vignettes/eheat_files/figure-html/anno_box-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vignettes/eheat_files/figure-html/ggheat-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ad38824

Please sign in to comment.