git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@109609 bc3139a8-67e5-0310-9ffc-ced21a209358
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 |
- |
|
103 |
+ |
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 |
|