1. ComplexHeatmap
  2. Commit af16b5ba76c83586ce3e27fb4a502c63546bfb83
Browse code

Commit made by the Bioconductor Git-SVN bridge.

Commit id: d7c51d4bf4c77efd4d0fd3a5ccdce1da6aa727b4

add wrapper function decorate_*



git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@107432 bc3139a8-67e5-0310-9ffc-ced21a209358

z.gu authored on 14/08/2015 15:04:04
Showing 8 changed files
NAMESPACE
History View file @ af16b5b
... ... 
@@ -18,6 +18,7 @@ export(decorate_dimnames)
18 18 
 export(column_anno_points)
19 19 
 exportMethods(component_height)
20 20 
 export(row_anno_text)
21 
+export(decorate_column_hclust)
21 22 
 exportMethods(draw_hclust)
22 23 
 exportClasses(SingleAnnotation)
23 24 
 export(SingleAnnotation)
... ... 
@@ -33,6 +34,7 @@ exportMethods(draw_heatmap_legend)
33 34 
 exportMethods(add_heatmap)
34 35 
 export(anno_barplot)
35 36 
 export(row_anno_boxplot)
37 
+export(decorate_row_title)
36 38 
 exportMethods(make_layout)
37 39 
 export(anno_histogram)
38 40 
 exportMethods(draw_dimnames)
... ... 
@@ -41,10 +43,12 @@ exportClasses(ColorMapping)
41 43 
 export(ColorMapping)
42 44 
 exportClasses(HeatmapAnnotation)
43 45 
 export(HeatmapAnnotation)
46 
+export(decorate_row_hclust)
44 47 
 export(anno_points)
45 48 
 exportMethods(draw_title)
46 49 
 export(ht_global_opt)
47 50 
 export('+.AdditiveUnit')
51 
+export(decorate_column_names)
48 52 
 export(column_anno_barplot)
49 53 
 export(densityHeatmap)
50 54 
 exportMethods(heatmap_legend_size)
... ... 
@@ -63,11 +67,13 @@ export(row_anno_histogram)
63 67 
 exportMethods(get_color_mapping_list)
64 68 
 exportMethods(make_row_cluster)
65 69 
 exportMethods(component_width)
70 
+export(decorate_column_title)
66 71 
 exportMethods(get_color_mapping_param_list)
67 72 
 export(grid.dendrogram)
68 73 
 export(decorate_title)
69 74 
 export(rowAnnotation)
70 75 
 export(columnAnnotation)
76 
+export(decorate_row_names)
71 77 
 export(anno_text)
72 78 
 export(anno_density)
73 79
R/decorate.R
History View file @ af16b5b
... ... 
@@ -68,6 +68,33 @@ decorate_hclust = function(heatmap, code, slice = 1, which = c("column", "row"))
68 68 
 	eval(substitute(code), envir = e)
69 69 
 }
70 70
71 
+# == title
72 
+# Decorate heatmap dendrogram on columns
73 
+#
74 
+# == param
75 
+# -... pass to `decorate_hclust`
76 
+#
77 
+# == details
78 
+# This is a wrapper function which pre-defined ``which`` argument in `decorate_hclust`.
79 
+#
80 
+decorate_column_hclust = function(...) {
81 
+	decorate_hclust(..., which = "column")
82 
+}
83 
+
84 
+# == title
85 
+# Decorate heatmap dendrogram on rows
86 
+#
87 
+# == param
88 
+# -... pass to `decorate_hclust`
89 
+#
90 
+# == details
91 
+# This is a wrapper function which pre-defined ``which`` argument in `decorate_hclust`.
92 
+#
93 
+decorate_row_hclust = function(...) {
94 
+	decorate_hclust(..., which = "row")
95 
+}
96 
+
97 
+
71 98 
 # == title
72 99 
 # Decorate the heatmap dimension names
73 100 
 #
... ... 
@@ -110,6 +137,33 @@ decorate_dimnames = function(heatmap, code, slice = 1, which = c("column", "row"
110 137 
 	eval(substitute(code), envir = e)
111 138 
 }
112 139
140 
+# == title
141 
+# Decorate heatmap row names
142 
+#
143 
+# == param
144 
+# -... pass to `decorate_dimnames`
145 
+#
146 
+# == details
147 
+# This is a wrapper function which pre-defined ``which`` argument in `decorate_dimnames`.
148 
+#
149 
+decorate_row_names = function(...) {
150 
+	decorate_dimnames(..., which = "row")
151 
+}
152 
+
153 
+# == title
154 
+# Decorate heatmap column names
155 
+#
156 
+# == param
157 
+# -... pass to `decorate_dimnames`
158 
+#
159 
+# == details
160 
+# This is a wrapper function which pre-defined ``which`` argument in `decorate_dimnames`.
161 
+#
162 
+decorate_column_names = function(...) {
163 
+	decorate_dimnames(..., which = "column")
164 
+}
165 
+
166 
+
113 167 
 # == title
114 168 
 # Decorate the heatmap title
115 169 
 #
... ... 
@@ -148,6 +202,32 @@ decorate_title = function(heatmap, code, slice = 1, which = c("column", "row"))
148 202 
 	eval(substitute(code), envir = e)
149 203 
 }
150 204
205 
+# == title
206 
+# Decorate heatmap row title
207 
+#
208 
+# == param
209 
+# -... pass to `decorate_title`
210 
+#
211 
+# == details
212 
+# This is a wrapper function which pre-defined ``which`` argument in `decorate_title`.
213 
+#
214 
+decorate_row_title = function(...) {
215 
+	decorate_title(..., which = "row")
216 
+}
217 
+
218 
+# == title
219 
+# Decorate heatmap column title
220 
+#
221 
+# == param
222 
+# -... pass to `decorate_title`
223 
+#
224 
+# == details
225 
+# This is a wrapper function which pre-defined ``which`` argument in `decorate_title`.
226 
+#
227 
+decorate_column_title = function(...) {
228 
+	decorate_title(..., which = "column")
229 
+}
230 
+
151 231 
 # == title
152 232 
 # Decorate the heatmap annotation
153 233 
 #
man/decorate_column_hclust.rd
History View file @ af16b5b
154 234 
new file mode 100644
... ... 
@@ -0,0 +1,19 @@
1 
+\name{decorate_column_hclust}
2 
+\alias{decorate_column_hclust}
3 
+\title{
4 
+Decorate heatmap dendrogram on columns
5 
+}
6 
+\description{
7 
+Decorate heatmap dendrogram on columns
8 
+}
9 
+\usage{
10 
+decorate_column_hclust(...)
11 
+}
12 
+\arguments{
13 
+
14 
+  \item{...}{pass to \code{\link{decorate_hclust}}}
15 
+
16 
+}
17 
+\details{
18 
+This is a wrapper function which pre-defined \code{which} argument in \code{\link{decorate_hclust}}.
19 
+}
man/decorate_column_names.rd
History View file @ af16b5b
0 20 
new file mode 100644
... ... 
@@ -0,0 +1,19 @@
1 
+\name{decorate_column_names}
2 
+\alias{decorate_column_names}
3 
+\title{
4 
+Decorate heatmap column names
5 
+}
6 
+\description{
7 
+Decorate heatmap column names
8 
+}
9 
+\usage{
10 
+decorate_column_names(...)
11 
+}
12 
+\arguments{
13 
+
14 
+  \item{...}{pass to \code{\link{decorate_dimnames}}}
15 
+
16 
+}
17 
+\details{
18 
+This is a wrapper function which pre-defined \code{which} argument in \code{\link{decorate_dimnames}}.
19 
+}
man/decorate_column_title.rd
History View file @ af16b5b
0 20 
new file mode 100644
... ... 
@@ -0,0 +1,19 @@
1 
+\name{decorate_column_title}
2 
+\alias{decorate_column_title}
3 
+\title{
4 
+Decorate heatmap column title
5 
+}
6 
+\description{
7 
+Decorate heatmap column title
8 
+}
9 
+\usage{
10 
+decorate_column_title(...)
11 
+}
12 
+\arguments{
13 
+
14 
+  \item{...}{pass to \code{\link{decorate_title}}}
15 
+
16 
+}
17 
+\details{
18 
+This is a wrapper function which pre-defined \code{which} argument in \code{\link{decorate_title}}.
19 
+}
man/decorate_row_hclust.rd
History View file @ af16b5b
0 20 
new file mode 100644
... ... 
@@ -0,0 +1,19 @@
1 
+\name{decorate_row_hclust}
2 
+\alias{decorate_row_hclust}
3 
+\title{
4 
+Decorate heatmap dendrogram on rows
5 
+}
6 
+\description{
7 
+Decorate heatmap dendrogram on rows
8 
+}
9 
+\usage{
10 
+decorate_row_hclust(...)
11 
+}
12 
+\arguments{
13 
+
14 
+  \item{...}{pass to \code{\link{decorate_hclust}}}
15 
+
16 
+}
17 
+\details{
18 
+This is a wrapper function which pre-defined \code{which} argument in \code{\link{decorate_hclust}}.
19 
+}
man/decorate_row_names.rd
History View file @ af16b5b
0 20 
new file mode 100644
... ... 
@@ -0,0 +1,19 @@
1 
+\name{decorate_row_names}
2 
+\alias{decorate_row_names}
3 
+\title{
4 
+Decorate heatmap row names
5 
+}
6 
+\description{
7 
+Decorate heatmap row names
8 
+}
9 
+\usage{
10 
+decorate_row_names(...)
11 
+}
12 
+\arguments{
13 
+
14 
+  \item{...}{pass to \code{\link{decorate_dimnames}}}
15 
+
16 
+}
17 
+\details{
18 
+This is a wrapper function which pre-defined \code{which} argument in \code{\link{decorate_dimnames}}.
19 
+}
man/decorate_row_title.rd
History View file @ af16b5b
0 20 
new file mode 100644
... ... 
@@ -0,0 +1,19 @@
1 
+\name{decorate_row_title}
2 
+\alias{decorate_row_title}
3 
+\title{
4 
+Decorate heatmap row title
5 
+}
6 
+\description{
7 
+Decorate heatmap row title
8 
+}
9 
+\usage{
10 
+decorate_row_title(...)
11 
+}
12 
+\arguments{
13 
+
14 
+  \item{...}{pass to \code{\link{decorate_title}}}
15 
+
16 
+}
17 
+\details{
18 
+This is a wrapper function which pre-defined \code{which} argument in \code{\link{decorate_title}}.
19 
+}