1. ComplexHeatmap
  2. man
  3. draw_heatmap_legend-HeatmapList-method.Rd
Browse code

add max_density argument

Zuguang Gu authored on 15/06/2022 10:42:56
Showing1 changed files
man/draw_heatmap_legend-HeatmapList-method.Rd
History View file @c94e524
... ... 
@@ -1,5 +1,6 @@
1 1 
 \name{draw_heatmap_legend-HeatmapList-method}
2 2 
 \alias{draw_heatmap_legend,HeatmapList-method}
3 
+\alias{draw_heatmap_legend}
3 4 
 \title{
4 5 
 Draw legends for All Heatmaps
5 6 
 }
... ... 
@@ -32,8 +33,8 @@ This function returns no value.
32 33 
 \author{
33 34 
 Zuguang Gu <z.gu@dkfz.de>
34 35 
 }
35 
-\alias{draw_heatmap_legend}
36 36 
 \examples{
37 37 
 # There is no example
38 38 
 NULL
39 
+
39 40 
 }
Browse code

rename to anno_textbox()

Zuguang Gu authored on 15/06/2022 10:11:58
Showing1 changed files
man/draw_heatmap_legend-HeatmapList-method.Rd
History View file @5cefa67
... ... 
@@ -1,6 +1,5 @@
1 1 
 \name{draw_heatmap_legend-HeatmapList-method}
2 2 
 \alias{draw_heatmap_legend,HeatmapList-method}
3 
-\alias{draw_heatmap_legend}
4 3 
 \title{
5 4 
 Draw legends for All Heatmaps
6 5 
 }
... ... 
@@ -33,8 +32,8 @@ This function returns no value.
33 32 
 \author{
34 33 
 Zuguang Gu <z.gu@dkfz.de>
35 34 
 }
35 
+\alias{draw_heatmap_legend}
36 36 
 \examples{
37 37 
 # There is no example
38 38 
 NULL
39 
-
40 39 
 }
Browse code

won't generate color matrix when type=='none'

Zuguang Gu authored on 15/12/2020 12:01:39
Showing1 changed files
man/draw_heatmap_legend-HeatmapList-method.Rd
History View file @110a6d6
... ... 
@@ -1,5 +1,6 @@
1 1 
 \name{draw_heatmap_legend-HeatmapList-method}
2 2 
 \alias{draw_heatmap_legend,HeatmapList-method}
3 
+\alias{draw_heatmap_legend}
3 4 
 \title{
4 5 
 Draw legends for All Heatmaps
5 6 
 }
... ... 
@@ -32,8 +33,8 @@ This function returns no value.
32 33 
 \author{
33 34 
 Zuguang Gu <z.gu@dkfz.de>
34 35 
 }
35 
-\alias{draw_heatmap_legend}
36 36 
 \examples{
37 37 
 # There is no example
38 38 
 NULL
39 
+
39 40 
 }
Browse code

translate stats::heatmap() and gplots::heatmap.2()

Zuguang Gu authored on 13/12/2020 20:54:51
Showing1 changed files
man/draw_heatmap_legend-HeatmapList-method.Rd
History View file @2f64420
... ... 
@@ -1,6 +1,5 @@
1 1 
 \name{draw_heatmap_legend-HeatmapList-method}
2 2 
 \alias{draw_heatmap_legend,HeatmapList-method}
3 
-\alias{draw_heatmap_legend}
4 3 
 \title{
5 4 
 Draw legends for All Heatmaps
6 5 
 }
... ... 
@@ -33,8 +32,8 @@ This function returns no value.
33 32 
 \author{
34 33 
 Zuguang Gu <z.gu@dkfz.de>
35 34 
 }
35 
+\alias{draw_heatmap_legend}
36 36 
 \examples{
37 37 
 # There is no example
38 38 
 NULL
39 
-
40 39 
 }
Browse code

update

Zuguang Gu authored on 20/10/2019 06:57:30
Showing1 changed files
man/draw_heatmap_legend-HeatmapList-method.Rd
History View file @7abc442
... ... 
@@ -1,5 +1,6 @@
1 1 
 \name{draw_heatmap_legend-HeatmapList-method}
2 2 
 \alias{draw_heatmap_legend,HeatmapList-method}
3 
+\alias{draw_heatmap_legend}
3 4 
 \title{
4 5 
 Draw legends for All Heatmaps
5 6 
 }
... ... 
@@ -32,8 +33,8 @@ This function returns no value.
32 33 
 \author{
33 34 
 Zuguang Gu <z.gu@dkfz.de>
34 35 
 }
35 
-\alias{draw_heatmap_legend}
36 36 
 \examples{
37 37 
 # There is no example
38 38 
 NULL
39 
+
39 40 
 }
Browse code

generate documentations by pkgdown

Zuguang Gu authored on 18/10/2019 11:34:02
Showing1 changed files
man/draw_heatmap_legend-HeatmapList-method.Rd
History View file @1cb7fea
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,39 @@
1 
+\name{draw_heatmap_legend-HeatmapList-method}
2 
+\alias{draw_heatmap_legend,HeatmapList-method}
3 
+\title{
4 
+Draw legends for All Heatmaps
5 
+}
6 
+\description{
7 
+Draw legends for All Heatmaps
8 
+}
9 
+\usage{
10 
+\S4method{draw_heatmap_legend}{HeatmapList}(object, legend_list = list(), ...)
11 
+}
12 
+\arguments{
13 
+
14 
+  \item{object}{A \code{\link{HeatmapList-class}} object.}
15 
+  \item{legend_list}{A list of self-defined legends, should be wrapped into \code{\link[grid:grid.grob]{grob}} objects. It is normally constructed by \code{\link{Legend}}.}
16 
+  \item{...}{Other arguments.}
17 
+
18 
+}
19 
+\details{
20 
+Actually we call the "heatmap legends" as the main legends.
21 
+For horizontal heatmap list, the legends are those from heamtap/row annotation/left/right annotation.
22 
+For vertical heatmap list, the legends are those from heamtap/column annotation/top/bottom annotation.
23 
+if \code{merge_legends} is true in \code{\link{draw,HeatmapList-method}}, then it contains all legends shown on the plot.
24 
+
25 
+A viewport is created which contains heatmap legends.
26 
+
27 
+This function is only for internal use.
28 
+}
29 
+\value{
30 
+This function returns no value.
31 
+}
32 
+\author{
33 
+Zuguang Gu <z.gu@dkfz.de>
34 
+}
35 
+\alias{draw_heatmap_legend}
36 
+\examples{
37 
+# There is no example
38 
+NULL
39 
+}