Browse code

Merge branch 'master' into devel

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

z.gu authored on 14/10/2015 09:59:57
Showing 6 changed files

... ...
@@ -85,7 +85,7 @@ export(rowAnnotation)
85 85
 export(columnAnnotation)
86 86
 export(decorate_row_names)
87 87
 export(anno_text)
88
-export(select)
88
+export(selectArea)
89 89
 export(anno_density)
90 90
 
91 91
 import(grid)
92 92
similarity index 97%
93 93
rename from R/select.R
94 94
rename to R/selectArea.R
... ...
@@ -1,9 +1,9 @@
1 1
 
2 2
 # == title
3
-# Select a region in the heatmap
3
+# Select an area in the heatmap
4 4
 #
5 5
 # == param
6
-# -mark whether mark the selected region as a rectangle
6
+# -mark whether mark the selected area as a rectangle
7 7
 #
8 8
 # == details
9 9
 # Users can use mouse to click two positions on the heatmap, the function
... ...
@@ -21,7 +21,7 @@
21 21
 # # No example for this function
22 22
 # NULL
23 23
 # 
24
-select = function(mark = FALSE) {
24
+selectArea = function(mark = FALSE) {
25 25
 
26 26
 	if(!interactive()) {
27 27
 		stop("`select()` can only be used under interactive mode.")
... ...
@@ -142,7 +142,7 @@ select = function(mark = FALSE) {
142 142
 	}
143 143
 
144 144
 	cat("\nTwo clicks should be in one same heatmap (or slice) region.\n\n")
145
-	select(mark = mark)
145
+	selectArea(mark = mark)
146 146
 
147 147
 }
148 148
 
... ...
@@ -100,4 +100,4 @@ oncoPrint to enphasize sub groups.
100 100
 
101 101
 You can use mouse to select a region on the heatmap, it will return row index and column index which correspond to the selected region.
102 102
 
103
-![download](https://cloud.githubusercontent.com/assets/449218/9685087/456d6276-531c-11e5-9837-2ba8a081ad50.gif)
103
+![select_region](https://cloud.githubusercontent.com/assets/449218/10479344/2981c27a-7264-11e5-9868-7400c5dc620d.gif)
104 104
similarity index 72%
105 105
rename from man/select.rd
106 106
rename to man/selectArea.rd
... ...
@@ -1,17 +1,17 @@
1
-\name{select}
2
-\alias{select}
1
+\name{selectArea}
2
+\alias{selectArea}
3 3
 \title{
4
-Select a region in the heatmap
4
+Select an area in the heatmap
5 5
 }
6 6
 \description{
7
-Select a region in the heatmap
7
+Select an area in the heatmap
8 8
 }
9 9
 \usage{
10
-select(mark = FALSE)
10
+selectArea(mark = FALSE)
11 11
 }
12 12
 \arguments{
13 13
 
14
-  \item{mark}{whether mark the selected region as a rectangle}
14
+  \item{mark}{whether mark the selected area as a rectangle}
15 15
 
16 16
 }
17 17
 \details{
... ...
@@ -29,7 +29,7 @@ options(width = 100)
29 29
 ```
30 30
 
31 31
 If the heatmap is plotted in the interactive graphic device, users can use mouse
32
-to select a sub-region in the heatmap and retrieve index for rows and columns in that selected region.
32
+to select a sub-area in the heatmap and retrieve index for rows and columns in that selected area.
33 33
 Since heatmaps are always used to visualize patterns that are clustered together, 
34 34
 this feature can greatly give convinience to extract the sub-matrix that users are interested in.
35 35
 
36 36
Binary files a/vignettes/select_region.gif and b/vignettes/select_region.gif differ