... | ... |
@@ -17,7 +17,9 @@ The [**InteractiveComplexHeatmap**](https://github.com/jokergoo/InteractiveCompl |
17 | 17 |
|
18 | 18 |
## Citation |
19 | 19 |
|
20 |
-Zuguang Gu, et al., [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016 |
|
20 |
+Zuguang Gu, et al., [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016. |
|
21 |
+ |
|
22 |
+Zuguang Gu. [Complex Heatmap Visualization](https://doi.org/10.1002/imt2.43), iMeta, 2022. |
|
21 | 23 |
|
22 | 24 |
|
23 | 25 |
## Install |
... | ... |
@@ -1,6 +1,6 @@ |
1 | 1 |
# Make Complex Heatmaps <a href="https://jokergoo.github.io/ComplexHeatmap-reference/book/"><img src="https://jokergoo.github.io/ComplexHeatmap-reference/book/complexheatmap-cover.jpg" width=240 align="right" style="border:2px solid black;" ></a> |
2 | 2 |
|
3 |
-[](https://travis-ci.org/jokergoo/ComplexHeatmap) |
|
3 |
+[](https://github.com/jokergoo/ComplexHeatmap/actions) |
|
4 | 4 |
[](https://codecov.io/github/jokergoo/ComplexHeatmap) |
5 | 5 |
[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
6 | 6 |
[](http://bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html) |
... | ... |
@@ -17,7 +17,7 @@ The [**InteractiveComplexHeatmap**](https://github.com/jokergoo/InteractiveCompl |
17 | 17 |
|
18 | 18 |
## Citation |
19 | 19 |
|
20 |
-Zuguang Gu, Roland Eils and Matthias Schlesner, [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016 |
|
20 |
+Zuguang Gu, et al., [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016 |
|
21 | 21 |
|
22 | 22 |
|
23 | 23 |
## Install |
... | ... |
@@ -73,6 +73,7 @@ The full documentations are available at https://jokergoo.github.io/ComplexHeatm |
73 | 73 |
|
74 | 74 |
There are following blog posts focusing on specific topics: |
75 | 75 |
|
76 |
+- [Make 3D heatmap](https://jokergoo.github.io/2021/03/24/3d-heatmap/) |
|
76 | 77 |
- [Translate from pheatmap to ComplexHeatmap](https://jokergoo.github.io/2020/05/06/translate-from-pheatmap-to-complexheatmap/) |
77 | 78 |
- [Set cell width/height in the heatmap](https://jokergoo.github.io/2020/05/11/set-cell-width/height-in-the-heatmap/) |
78 | 79 |
- [Interactive ComplexHeatmap](https://jokergoo.github.io/2020/05/15/interactive-complexheatmap/) |
... | ... |
@@ -105,6 +105,12 @@ There are following blog posts focusing on specific topics: |
105 | 105 |
|
106 | 106 |
<img src="https://user-images.githubusercontent.com/449218/102615477-48c76a80-4136-11eb-98d9-3c528844fbe8.png" width=500 /> |
107 | 107 |
|
108 |
+### 3D heatmap |
|
109 |
+ |
|
110 |
+ |
|
111 |
+ |
|
112 |
+ |
|
113 |
+ |
|
108 | 114 |
## License |
109 | 115 |
|
110 | 116 |
MIT @ Zuguang Gu |
... | ... |
@@ -13,6 +13,8 @@ sources of data sets and reveal potential patterns. Here the |
13 | 13 |
**ComplexHeatmap** package provides a highly flexible way to arrange multiple |
14 | 14 |
heatmaps and supports various annotation graphics. |
15 | 15 |
|
16 |
+The [**InteractiveComplexHeatmap**](https://github.com/jokergoo/InteractiveComplexHeatmap) package can directly export static complex heatmaps into an interactive Shiny app. Have a try! |
|
17 |
+ |
|
16 | 18 |
## Citation |
17 | 19 |
|
18 | 20 |
Zuguang Gu, Roland Eils and Matthias Schlesner, [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016 |
... | ... |
@@ -101,7 +101,7 @@ There are following blog posts focusing on specific topics: |
101 | 101 |
|
102 | 102 |
### UpSet plot |
103 | 103 |
|
104 |
-<img src="https://user-images.githubusercontent.com/449218/102615477-48c76a80-4136-11eb-98d9-3c528844fbe8.png" width=700 /> |
|
104 |
+<img src="https://user-images.githubusercontent.com/449218/102615477-48c76a80-4136-11eb-98d9-3c528844fbe8.png" width=500 /> |
|
105 | 105 |
|
106 | 106 |
## License |
107 | 107 |
|
... | ... |
@@ -101,14 +101,7 @@ There are following blog posts focusing on specific topics: |
101 | 101 |
|
102 | 102 |
### UpSet plot |
103 | 103 |
|
104 |
- |
|
105 |
- |
|
106 |
-### Interactive heatmaps |
|
107 |
- |
|
108 |
-Heatmaps can be exported into a Shiny app by `ht_shiny(ht)`. See examples at https://jokergoo.shinyapps.io/interactive_complexheatmap/. |
|
109 |
- |
|
110 |
-<img src="https://user-images.githubusercontent.com/449218/82199376-e5eec600-98fd-11ea-9fca-ad95d405dc20.gif" /> |
|
111 |
- |
|
104 |
+<img src="https://user-images.githubusercontent.com/449218/102615477-48c76a80-4136-11eb-98d9-3c528844fbe8.png" width=700 /> |
|
112 | 105 |
|
113 | 106 |
## License |
114 | 107 |
|
... | ... |
@@ -107,7 +107,7 @@ There are following blog posts focusing on specific topics: |
107 | 107 |
|
108 | 108 |
Heatmaps can be exported into a Shiny app by `ht_shiny(ht)`. See examples at https://jokergoo.shinyapps.io/interactive_complexheatmap/. |
109 | 109 |
|
110 |
-https://user-images.githubusercontent.com/449218/82199376-e5eec600-98fd-11ea-9fca-ad95d405dc20.gif |
|
110 |
+<img src="https://user-images.githubusercontent.com/449218/82199376-e5eec600-98fd-11ea-9fca-ad95d405dc20.gif" /> |
|
111 | 111 |
|
112 | 112 |
|
113 | 113 |
## License |
... | ... |
@@ -71,14 +71,14 @@ The full documentations are available at https://jokergoo.github.io/ComplexHeatm |
71 | 71 |
|
72 | 72 |
There are following blog posts focusing on specific topics: |
73 | 73 |
|
74 |
--[Translate from pheatmap to ComplexHeatmap](https://jokergoo.github.io/2020/05/06/translate-from-pheatmap-to-complexheatmap/) |
|
75 |
--[Set cell width/height in the heatmap](https://jokergoo.github.io/2020/05/11/set-cell-width/height-in-the-heatmap/) |
|
76 |
--[Interactive ComplexHeatmap](https://jokergoo.github.io/2020/05/15/interactive-complexheatmap/) |
|
77 |
--[Word cloud as heatmap annotation](https://jokergoo.github.io/2020/05/31/word-cloud-as-heatmap-annotation/) |
|
78 |
--[Which heatmap function is faster?](https://jokergoo.github.io/2020/06/19/which-heatmap-function-is-faster/) |
|
79 |
--[Rasterization in ComplexHeatmap](https://jokergoo.github.io/2020/06/30/rasterization-in-complexheatmap/) |
|
80 |
--[Block annotation over several slices](https://jokergoo.github.io/2020/07/06/block-annotation-over-several-slices/) |
|
81 |
--[Integrate ComplexHeatmap with cowplot package](https://jokergoo.github.io/2020/07/14/integrate-complexheatmap-with-cowplot-package/) |
|
74 |
+- [Translate from pheatmap to ComplexHeatmap](https://jokergoo.github.io/2020/05/06/translate-from-pheatmap-to-complexheatmap/) |
|
75 |
+- [Set cell width/height in the heatmap](https://jokergoo.github.io/2020/05/11/set-cell-width/height-in-the-heatmap/) |
|
76 |
+- [Interactive ComplexHeatmap](https://jokergoo.github.io/2020/05/15/interactive-complexheatmap/) |
|
77 |
+- [Word cloud as heatmap annotation](https://jokergoo.github.io/2020/05/31/word-cloud-as-heatmap-annotation/) |
|
78 |
+- [Which heatmap function is faster?](https://jokergoo.github.io/2020/06/19/which-heatmap-function-is-faster/) |
|
79 |
+- [Rasterization in ComplexHeatmap](https://jokergoo.github.io/2020/06/30/rasterization-in-complexheatmap/) |
|
80 |
+- [Block annotation over several slices](https://jokergoo.github.io/2020/07/06/block-annotation-over-several-slices/) |
|
81 |
+- [Integrate ComplexHeatmap with cowplot package](https://jokergoo.github.io/2020/07/14/integrate-complexheatmap-with-cowplot-package/) |
|
82 | 82 |
|
83 | 83 |
|
84 | 84 |
## Examples |
... | ... |
@@ -17,9 +17,6 @@ heatmaps and supports various annotation graphics. |
17 | 17 |
|
18 | 18 |
Zuguang Gu, Roland Eils and Matthias Schlesner, [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016 |
19 | 19 |
|
20 |
-## Documentation |
|
21 |
- |
|
22 |
-The full documentations are available at https://jokergoo.github.io/ComplexHeatmap-reference/book/ and the website is at https://jokergoo.github.io/ComplexHeatmap. |
|
23 | 20 |
|
24 | 21 |
## Install |
25 | 22 |
|
... | ... |
@@ -66,6 +63,24 @@ ha = HeatmapAnnotation(df = anno1, anno_fun = anno2, ..., which = "row") |
66 | 63 |
Heatmap(mat1, ...) + Heatmap(mat2, ...) + ha |
67 | 64 |
``` |
68 | 65 |
|
66 |
+## Documentation |
|
67 |
+ |
|
68 |
+The full documentations are available at https://jokergoo.github.io/ComplexHeatmap-reference/book/ and the website is at https://jokergoo.github.io/ComplexHeatmap. |
|
69 |
+ |
|
70 |
+## Blog posts |
|
71 |
+ |
|
72 |
+There are following blog posts focusing on specific topics: |
|
73 |
+ |
|
74 |
+-[Translate from pheatmap to ComplexHeatmap](https://jokergoo.github.io/2020/05/06/translate-from-pheatmap-to-complexheatmap/) |
|
75 |
+-[Set cell width/height in the heatmap](https://jokergoo.github.io/2020/05/11/set-cell-width/height-in-the-heatmap/) |
|
76 |
+-[Interactive ComplexHeatmap](https://jokergoo.github.io/2020/05/15/interactive-complexheatmap/) |
|
77 |
+-[Word cloud as heatmap annotation](https://jokergoo.github.io/2020/05/31/word-cloud-as-heatmap-annotation/) |
|
78 |
+-[Which heatmap function is faster?](https://jokergoo.github.io/2020/06/19/which-heatmap-function-is-faster/) |
|
79 |
+-[Rasterization in ComplexHeatmap](https://jokergoo.github.io/2020/06/30/rasterization-in-complexheatmap/) |
|
80 |
+-[Block annotation over several slices](https://jokergoo.github.io/2020/07/06/block-annotation-over-several-slices/) |
|
81 |
+-[Integrate ComplexHeatmap with cowplot package](https://jokergoo.github.io/2020/07/14/integrate-complexheatmap-with-cowplot-package/) |
|
82 |
+ |
|
83 |
+ |
|
69 | 84 |
## Examples |
70 | 85 |
|
71 | 86 |
### Visualize Methylation Profile with Complex Annotations |
... | ... |
@@ -88,6 +103,13 @@ Heatmap(mat1, ...) + Heatmap(mat2, ...) + ha |
88 | 103 |
|
89 | 104 |
 |
90 | 105 |
|
106 |
+### Interactive heatmaps |
|
107 |
+ |
|
108 |
+Heatmaps can be exported into a Shiny app by `ht_shiny(ht)`. See examples at https://jokergoo.shinyapps.io/interactive_complexheatmap/. |
|
109 |
+ |
|
110 |
+https://user-images.githubusercontent.com/449218/82199376-e5eec600-98fd-11ea-9fca-ad95d405dc20.gif |
|
111 |
+ |
|
112 |
+ |
|
91 | 113 |
## License |
92 | 114 |
|
93 | 115 |
MIT @ Zuguang Gu |
... | ... |
@@ -3,7 +3,6 @@ |
3 | 3 |
[](https://travis-ci.org/jokergoo/ComplexHeatmap) |
4 | 4 |
[](https://codecov.io/github/jokergoo/ComplexHeatmap) |
5 | 5 |
[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
6 |
-[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
|
7 | 6 |
[](http://bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html) |
8 | 7 |
|
9 | 8 |
<img src="http://jokergoo.github.io/complexheatmap_logo.svg" width="550"> |
... | ... |
@@ -6,7 +6,7 @@ |
6 | 6 |
[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
7 | 7 |
[](http://bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html) |
8 | 8 |
|
9 |
-<img src="http://jokergoo.github.io/complexheatmap_logo.svg" width="600"> |
|
9 |
+<img src="http://jokergoo.github.io/complexheatmap_logo.svg" width="550"> |
|
10 | 10 |
|
11 | 11 |
|
12 | 12 |
Complex heatmaps are efficient to visualize associations between different |
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-<a href="https://jokergoo.github.io/ComplexHeatmap-reference/book/"><img src="https://jokergoo.github.io/ComplexHeatmap-reference/book/complexheatmap-cover.jpg" width=240 align="right" style="border:2px solid black;" ></a> |
|
1 |
+# Make Complex Heatmaps <a href="https://jokergoo.github.io/ComplexHeatmap-reference/book/"><img src="https://jokergoo.github.io/ComplexHeatmap-reference/book/complexheatmap-cover.jpg" width=240 align="right" style="border:2px solid black;" ></a> |
|
2 | 2 |
|
3 | 3 |
[](https://travis-ci.org/jokergoo/ComplexHeatmap) |
4 | 4 |
[](https://codecov.io/github/jokergoo/ComplexHeatmap) |
... | ... |
@@ -8,26 +8,25 @@ |
8 | 8 |
|
9 | 9 |
<img src="http://jokergoo.github.io/complexheatmap_logo.svg" width="600"> |
10 | 10 |
|
11 |
-## Make Complex Heatmaps |
|
12 | 11 |
|
13 | 12 |
Complex heatmaps are efficient to visualize associations between different |
14 | 13 |
sources of data sets and reveal potential patterns. Here the |
15 | 14 |
**ComplexHeatmap** package provides a highly flexible way to arrange multiple |
16 | 15 |
heatmaps and supports various annotation graphics. |
17 | 16 |
|
18 |
-### Citation |
|
17 |
+## Citation |
|
19 | 18 |
|
20 | 19 |
Zuguang Gu, Roland Eils and Matthias Schlesner, [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016 |
21 | 20 |
|
22 |
-### Documentation |
|
21 |
+## Documentation |
|
23 | 22 |
|
24 |
-The full documentations are available at https://jokergoo.github.io/ComplexHeatmap-reference/book/. |
|
23 |
+The full documentations are available at https://jokergoo.github.io/ComplexHeatmap-reference/book/ and the website is at https://jokergoo.github.io/ComplexHeatmap. |
|
25 | 24 |
|
26 |
-### Install |
|
25 |
+## Install |
|
27 | 26 |
|
28 | 27 |
`ComplexHeatmap` is available on [Bioconductor](http://www.bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html), you can install it by: |
29 | 28 |
|
30 |
-```{r} |
|
29 |
+```r |
|
31 | 30 |
if (!requireNamespace("BiocManager", quietly=TRUE)) |
32 | 31 |
install.packages("BiocManager") |
33 | 32 |
BiocManager::install("ComplexHeatmap") |
... | ... |
@@ -35,62 +34,62 @@ BiocManager::install("ComplexHeatmap") |
35 | 34 |
|
36 | 35 |
If you want the latest version, install it directly from GitHub: |
37 | 36 |
|
38 |
-```{r} |
|
37 |
+```r |
|
39 | 38 |
library(devtools) |
40 | 39 |
install_github("jokergoo/ComplexHeatmap") |
41 | 40 |
``` |
42 | 41 |
|
43 |
-### Usage |
|
42 |
+## Usage |
|
44 | 43 |
|
45 | 44 |
Make a single heatmap: |
46 | 45 |
|
47 |
-```{r} |
|
46 |
+```r |
|
48 | 47 |
Heatmap(mat, ...) |
49 | 48 |
``` |
50 | 49 |
|
51 | 50 |
A single Heatmap with column annotations: |
52 | 51 |
|
53 |
-```{r} |
|
52 |
+```r |
|
54 | 53 |
ha = HeatmapAnnotation(df = anno1, anno_fun = anno2, ...) |
55 | 54 |
Heatmap(mat, ..., top_annotation = ha) |
56 | 55 |
``` |
57 | 56 |
|
58 | 57 |
Make a list of heatmaps: |
59 | 58 |
|
60 |
-```{r} |
|
59 |
+```r |
|
61 | 60 |
Heatmap(mat1, ...) + Heatmap(mat2, ...) |
62 | 61 |
``` |
63 | 62 |
|
64 | 63 |
Make a list of heatmaps and row annotations: |
65 | 64 |
|
66 |
-```{r} |
|
65 |
+```r |
|
67 | 66 |
ha = HeatmapAnnotation(df = anno1, anno_fun = anno2, ..., which = "row") |
68 | 67 |
Heatmap(mat1, ...) + Heatmap(mat2, ...) + ha |
69 | 68 |
``` |
70 | 69 |
|
71 |
-### Examples |
|
70 |
+## Examples |
|
72 | 71 |
|
73 |
-#### Visualize Methylation Profile with Complex Annotations |
|
72 |
+### Visualize Methylation Profile with Complex Annotations |
|
74 | 73 |
|
75 | 74 |
 |
76 | 75 |
|
77 |
-#### Correlations between methylation, expression and other genomic features |
|
76 |
+### Correlations between methylation, expression and other genomic features |
|
78 | 77 |
|
79 | 78 |
 |
80 | 79 |
|
81 |
-#### Visualize Cell Heterogeneity from Single Cell RNASeq |
|
80 |
+### Visualize Cell Heterogeneity from Single Cell RNASeq |
|
82 | 81 |
|
83 | 82 |
 |
84 | 83 |
|
85 |
-#### Making Enhanced OncoPrint |
|
84 |
+### Making Enhanced OncoPrint |
|
86 | 85 |
|
87 | 86 |
 |
88 | 87 |
|
89 |
-#### UpSet plot |
|
88 |
+### UpSet plot |
|
90 | 89 |
|
91 |
- |
|
90 |
+ |
|
92 | 91 |
|
93 |
-### License |
|
92 |
+## License |
|
94 | 93 |
|
95 | 94 |
MIT @ Zuguang Gu |
96 | 95 |
|
... | ... |
@@ -6,6 +6,8 @@ |
6 | 6 |
[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
7 | 7 |
[](http://bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html) |
8 | 8 |
|
9 |
+<img src="http://jokergoo.github.io/complexheatmap_logo.svg" width="600"> |
|
10 |
+ |
|
9 | 11 |
## Make Complex Heatmaps |
10 | 12 |
|
11 | 13 |
Complex heatmaps are efficient to visualize associations between different |
... | ... |
@@ -2,7 +2,7 @@ |
2 | 2 |
|
3 | 3 |
[](https://travis-ci.org/jokergoo/ComplexHeatmap) |
4 | 4 |
[](https://codecov.io/github/jokergoo/ComplexHeatmap) |
5 |
-[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
|
5 |
+[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
|
6 | 6 |
[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
7 | 7 |
[](http://bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html) |
8 | 8 |
|
... | ... |
@@ -84,6 +84,10 @@ Heatmap(mat1, ...) + Heatmap(mat2, ...) + ha |
84 | 84 |
|
85 | 85 |
 |
86 | 86 |
|
87 |
+#### UpSet plot |
|
88 |
+ |
|
89 |
+ |
|
90 |
+ |
|
87 | 91 |
### License |
88 | 92 |
|
89 | 93 |
MIT @ Zuguang Gu |
... | ... |
@@ -23,7 +23,7 @@ The full documentations are available at https://jokergoo.github.io/ComplexHeatm |
23 | 23 |
|
24 | 24 |
### Install |
25 | 25 |
|
26 |
-`ComplexHeatmap` is available on [Bioconductor](http://www.bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html), you can intall it by: |
|
26 |
+`ComplexHeatmap` is available on [Bioconductor](http://www.bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html), you can install it by: |
|
27 | 27 |
|
28 | 28 |
```{r} |
29 | 29 |
source("http://bioconductor.org/biocLite.R") |
... | ... |
@@ -1,3 +1,5 @@ |
1 |
+<a href="https://jokergoo.github.io/ComplexHeatmap-reference/book/"><img src="https://jokergoo.github.io/ComplexHeatmap-reference/book/complexheatmap-cover.jpg" width=240 align="right" style="border:2px solid black;" ></a> |
|
2 |
+ |
|
1 | 3 |
[](https://travis-ci.org/jokergoo/ComplexHeatmap) |
2 | 4 |
[](https://codecov.io/github/jokergoo/ComplexHeatmap) |
3 | 5 |
[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
... | ... |
@@ -6,40 +8,18 @@ |
6 | 8 |
|
7 | 9 |
## Make Complex Heatmaps |
8 | 10 |
|
9 |
-Complex heatmaps are efficient to visualize associations |
|
10 |
-between different sources of data sets and reveal potential structures. |
|
11 |
-Here the **ComplexHeatmap** package provides a highly flexible way to arrange |
|
12 |
-multiple heatmaps and supports self-defined annotation graphics. |
|
11 |
+Complex heatmaps are efficient to visualize associations between different |
|
12 |
+sources of data sets and reveal potential patterns. Here the |
|
13 |
+**ComplexHeatmap** package provides a highly flexible way to arrange multiple |
|
14 |
+heatmaps and supports various annotation graphics. |
|
13 | 15 |
|
14 | 16 |
### Citation |
15 | 17 |
|
16 | 18 |
Zuguang Gu, Roland Eils and Matthias Schlesner, [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016 |
17 | 19 |
|
18 |
-### General design |
|
19 |
- |
|
20 |
-Generally, a heatmap list contains several heatmaps and row annotations. |
|
21 |
- |
|
22 |
- |
|
23 |
- |
|
24 |
-Surrounding the heatmap list, |
|
25 |
-there are legends for heatmaps and annotations, also there are titles which are placed |
|
26 |
-on the four sides of the heatmap list. And for each heatmap, there are also different components |
|
27 |
-surrounding the heatmap body. |
|
28 |
- |
|
29 |
-The **ComplexHeatmap** package is implemented in an object-oriented way. To describe a heatmap list, |
|
30 |
-there are following classes: |
|
31 |
- |
|
32 |
-- `Heatmap` class: a single heatmap containing heatmap body, row/column names, titles, dendrograms and column annotations. |
|
33 |
-- `HeatmapList` class: a list of heatmaps and row annotations. |
|
34 |
-- `HeatmapAnnotation` class: defines a list of row annotations and column annotations. |
|
35 |
- |
|
36 |
-There are also several internal classes: |
|
37 |
- |
|
38 |
-- `SingleAnnotation` class: defines a single row annotation or column annotation. |
|
39 |
-- `ColorMapping` class: mapping from values to colors. |
|
20 |
+### Documentation |
|
40 | 21 |
|
41 |
-**ComplexHeatmap** is implemented under **grid** system, so users should know basic **grid** functionality |
|
42 |
-to get full use of the package. |
|
22 |
+The full documentations are available at https://jokergoo.github.io/ComplexHeatmap-reference/book/. |
|
43 | 23 |
|
44 | 24 |
### Install |
45 | 25 |
|
... | ... |
@@ -85,108 +65,25 @@ ha = HeatmapAnnotation(df = anno1, anno_fun = anno2, ..., which = "row") |
85 | 65 |
Heatmap(mat1, ...) + Heatmap(mat2, ...) + ha |
86 | 66 |
``` |
87 | 67 |
|
88 |
-### As a base package |
|
89 |
- |
|
90 |
-**ComplexHeatmap** can be used as a base package to build other packages which focus |
|
91 |
-On specific applications. E.g. [EnrichedHeatmap](http://github.com/jokergoo/EnrichedHeatmap) package |
|
92 |
-uses **ComplexHeatmap** as base to make heatmaps which visualize the enrichment of genomic signals |
|
93 |
-to specific target regions. |
|
94 |
- |
|
95 |
-### Vignettes |
|
96 |
- |
|
97 |
-There are several vignettes in the package. Each vignette focuses on a specific topic. Following |
|
98 |
-lists the general topics discussed in these vignettes: |
|
99 |
- |
|
100 |
- 1. [**Making a Single Heatmap**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s2.single_heatmap.html) |
|
101 |
- |
|
102 |
- This vignette introduces the basic configuration for making a single heatmap. Similar as other |
|
103 |
- R functions/packages, the basic usage is quite similar, but there are several unique features |
|
104 |
- for **ComplexHeamtap** package. |
|
105 |
- - Works both for numeric matrix and character matrix |
|
106 |
- - For numeric matrix which contains continuous values, the package allows a color mapping function |
|
107 |
- which can give more accurate colors and be robust to outliers. |
|
108 |
- - Highly flexible for clustering. You can define the distance method for clustering by: |
|
109 |
- * a pre-defined distance such as "euclidean" or "pearson" |
|
110 |
- * a self-defined function which calculates distance from a matrix. |
|
111 |
- * a self-defined function which calculates distance from two vectors |
|
112 |
- |
|
113 |
- You can define the clustering method by: |
|
114 |
- * a clustering function such as `diana()` from **cluster** package |
|
115 |
- * a `hclust` or `dendrogram` object. |
|
116 |
- - `NA` is allowed for clustering and heatmap visualization. |
|
117 |
- - Dendrogram and dimension names can be put on any side of the heatmap. |
|
118 |
- - Rows on the heatmap can be split by `cutree`, by `kmeans` or by a data frame which contains |
|
119 |
- different levels that split the heatmap. |
|
120 |
- - The heatmap body itself can be completely self-defined. |
|
121 |
- |
|
122 |
- 2. [**Making a List of Heatmaps**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s3.a_list_of_heatmaps.html) |
|
123 |
- |
|
124 |
- This vignette introduces how to concatenate a list of heatmaps and how adjustment is applied to keep |
|
125 |
- the correspondence of the heatmaps. |
|
68 |
+### Examples |
|
126 | 69 |
|
127 |
- 3. [**Heatmap Annotations**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s4.heatmap_annotation.html) |
|
70 |
+#### Visualize Methylation Profile with Complex Annotations |
|
128 | 71 |
|
129 |
- This vignette introduces the concept of the heatmap annotation and demonstrate how to make simple annotations |
|
130 |
- as well as complex annotations. Also, the vignette explains the difference between column annotations |
|
131 |
- and row annotations. |
|
72 |
+ |
|
132 | 73 |
|
133 |
- 4. [**Heatmap and Annotation Legends**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s5.legend.html) |
|
74 |
+#### Correlations between methylation, expression and other genomic features |
|
134 | 75 |
|
135 |
- This vignette introduces how to configurate the heatmap legend and annotation legend, also |
|
136 |
- how to add self-defined legends. |
|
76 |
+ |
|
137 | 77 |
|
138 |
- 5. [**Heatmap Decoration**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s6.heatmap_decoration.html) |
|
78 |
+#### Visualize Cell Heterogeneity from Single Cell RNASeq |
|
139 | 79 |
|
140 |
- This vignette introduces methods to add more self-defined graphics to the heatmaps after the heatmaps |
|
141 |
- are generated. |
|
80 |
+ |
|
142 | 81 |
|
143 |
- 6. [**Interactive with Heatmaps**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s7.interactive.html) |
|
82 |
+#### Making Enhanced OncoPrint |
|
144 | 83 |
|
145 |
- How to select a region in the heatmap to retrieve the sub-matrix. |
|
146 |
- |
|
147 |
- 7. [**OncoPrint**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s8.oncoprint.html) |
|
148 |
- |
|
149 |
- How to make an oncoPrint. |
|
150 |
- |
|
151 |
- 8. [**Examples**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s9.examples.html) |
|
152 |
- |
|
153 |
- More simulated and real-world examples are shown in this vignette. |
|
154 |
- |
|
155 |
- |
|
156 |
-### Visualize high dimensional genomic data |
|
157 |
- |
|
158 |
-The examples visualizes correlation between methylation and expression, as well as other annotation information (data are randomly generated). In the heatmap, each row corresponds to a differentially methylated regions (DMRs). |
|
159 |
-From left to right, heatmaps are: |
|
160 |
- |
|
161 |
-1. methylation for each DMRs in samples. |
|
162 |
-2. direction of the methylation (one column heatmap), i.e. is methylation hyper in tumor or hypo? |
|
163 |
-3. expression for the genes that are associated with corresponding DMRs (e.g. closest gene). |
|
164 |
-4. signiciance for the correlation between methylation and expression (-log10(p-value)). |
|
165 |
-5. type of genes, i.e. is the gene a protein coding gene or a lincRNA? |
|
166 |
-6. annotation to gene models, i.e. is the DMR located in the intragenic region of the corresponding gene or the DMR is intergenic? |
|
167 |
-7. distance from the DMR to the TSS of the corresponding gene. |
|
168 |
-8. overlapping between DMRs and enhancers (Color shows how much the DMR is covered by the enhancers). |
|
169 |
- |
|
170 |
- |
|
171 |
- |
|
172 |
-### OncoPrint |
|
173 |
- |
|
174 |
-<a href="http://www.cbioportal.org/faq.jsp#what-are-oncoprints">OncoPrint</a> visualize multiple genomic alteration |
|
175 |
-events through a heatmap. From verion 1.3.0, **ComplexHeatmap** package provides a new `oncoPrint()` function. By this |
|
176 |
-function, users can define their own graphics which correspond to differnet alteration events. Also the function additionally |
|
177 |
-add barplots on two sides of the heatmap which tell number of different alterations in patients or samples. |
|
178 |
- |
|
179 |
-With general functionality of **ComplexHeamtap**, you can add more heatmaps / row annotations to the oncoPrint, even split the |
|
180 |
-oncoPrint to enphasize sub groups. |
|
181 |
- |
|
182 |
- |
|
183 |
- |
|
184 |
-### Interact with heatmaps |
|
185 |
- |
|
186 |
-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. |
|
187 |
- |
|
188 |
-<p><img src="https://cloud.githubusercontent.com/assets/449218/10479344/2981c27a-7264-11e5-9868-7400c5dc620d.gif", width="600"></p> |
|
84 |
+ |
|
189 | 85 |
|
190 | 86 |
### License |
191 | 87 |
|
192 |
-GPL (>= 2) |
|
88 |
+MIT @ Zuguang Gu |
|
89 |
+ |
... | ... |
@@ -46,8 +46,9 @@ to get full use of the package. |
46 | 46 |
`ComplexHeatmap` is available on [Bioconductor](http://www.bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html), you can intall it by: |
47 | 47 |
|
48 | 48 |
```{r} |
49 |
-source("http://bioconductor.org/biocLite.R") |
|
50 |
-biocLite("ComplexHeatmap") |
|
49 |
+if (!requireNamespace("BiocManager", quietly=TRUE)) |
|
50 |
+ install.packages("BiocManager") |
|
51 |
+BiocManager::install("ComplexHeatmap") |
|
51 | 52 |
``` |
52 | 53 |
|
53 | 54 |
If you want the latest version, install it directly from GitHub: |
... | ... |
@@ -1,7 +1,7 @@ |
1 | 1 |
[](https://travis-ci.org/jokergoo/ComplexHeatmap) |
2 | 2 |
[](https://codecov.io/github/jokergoo/ComplexHeatmap) |
3 | 3 |
[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
4 |
-[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
|
4 |
+[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
|
5 | 5 |
[](http://bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html) |
6 | 6 |
|
7 | 7 |
## Make Complex Heatmaps |
... | ... |
@@ -1,4 +1,8 @@ |
1 |
-[](https://travis-ci.org/jokergoo/ComplexHeatmap) [](https://codecov.io/github/jokergoo/ComplexHeatmap) [](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/)  |
|
1 |
+[](https://travis-ci.org/jokergoo/ComplexHeatmap) |
|
2 |
+[](https://codecov.io/github/jokergoo/ComplexHeatmap) |
|
3 |
+[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
|
4 |
+[](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/) |
|
5 |
+[](http://bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html) |
|
2 | 6 |
|
3 | 7 |
## Make Complex Heatmaps |
4 | 8 |
|
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-[](https://travis-ci.org/jokergoo/ComplexHeatmap) [](https://codecov.io/github/jokergoo/ComplexHeatmap) [](http://bioconductor.org/packages/stats/bioc/ComplexHeatmap.html)  |
|
1 |
+[](https://travis-ci.org/jokergoo/ComplexHeatmap) [](https://codecov.io/github/jokergoo/ComplexHeatmap) [](https://bioconductor.org/packages/stats/bioc/ComplexHeatmap/)  |
|
2 | 2 |
|
3 | 3 |
## Make Complex Heatmaps |
4 | 4 |
|
... | ... |
@@ -7,6 +7,10 @@ between different sources of data sets and reveal potential structures. |
7 | 7 |
Here the **ComplexHeatmap** package provides a highly flexible way to arrange |
8 | 8 |
multiple heatmaps and supports self-defined annotation graphics. |
9 | 9 |
|
10 |
+### Citation |
|
11 |
+ |
|
12 |
+Zuguang Gu, Roland Eils and Matthias Schlesner, [Complex heatmaps reveal patterns and correlations in multidimensional genomic data](http://bioinformatics.oxfordjournals.org/content/early/2016/05/20/bioinformatics.btw313.abstract), Bioinformatics, 2016 |
|
13 |
+ |
|
10 | 14 |
### General design |
11 | 15 |
|
12 | 16 |
Generally, a heatmap list contains several heatmaps and row annotations. |
... | ... |
@@ -1,14 +1,13 @@ |
1 |
-[](https://travis-ci.org/jokergoo/ComplexHeatmap) |
|
1 |
+[](https://travis-ci.org/jokergoo/ComplexHeatmap) [](https://codecov.io/github/jokergoo/ComplexHeatmap) [](http://bioconductor.org/packages/stats/bioc/ComplexHeatmap.html)  |
|
2 | 2 |
|
3 |
-Make Complex Heatmaps |
|
4 |
-========================= |
|
3 |
+## Make Complex Heatmaps |
|
5 | 4 |
|
6 | 5 |
Complex heatmaps are efficient to visualize associations |
7 | 6 |
between different sources of data sets and reveal potential structures. |
8 | 7 |
Here the **ComplexHeatmap** package provides a highly flexible way to arrange |
9 | 8 |
multiple heatmaps and supports self-defined annotation graphics. |
10 | 9 |
|
11 |
-## General design |
|
10 |
+### General design |
|
12 | 11 |
|
13 | 12 |
Generally, a heatmap list contains several heatmaps and row annotations. |
14 | 13 |
|
... | ... |
@@ -179,3 +178,7 @@ oncoPrint to enphasize sub groups. |
179 | 178 |
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. |
180 | 179 |
|
181 | 180 |
<p><img src="https://cloud.githubusercontent.com/assets/449218/10479344/2981c27a-7264-11e5-9868-7400c5dc620d.gif", width="600"></p> |
181 |
+ |
|
182 |
+### License |
|
183 |
+ |
|
184 |
+GPL (>= 2) |
... | ... |
@@ -90,7 +90,7 @@ to specific target regions. |
90 | 90 |
There are several vignettes in the package. Each vignette focuses on a specific topic. Following |
91 | 91 |
lists the general topics discussed in these vignettes: |
92 | 92 |
|
93 |
- 1. [**Making a Single Heatmap**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s2.single_heatmap.html) |
|
93 |
+ 1. [**Making a Single Heatmap**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s2.single_heatmap.html) |
|
94 | 94 |
|
95 | 95 |
This vignette introduces the basic configuration for making a single heatmap. Similar as other |
96 | 96 |
R functions/packages, the basic usage is quite similar, but there are several unique features |
... | ... |
@@ -112,36 +112,36 @@ lists the general topics discussed in these vignettes: |
112 | 112 |
different levels that split the heatmap. |
113 | 113 |
- The heatmap body itself can be completely self-defined. |
114 | 114 |
|
115 |
- 2. [**Making a List of Heatmaps**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s3.a_list_of_heatmaps.html) |
|
115 |
+ 2. [**Making a List of Heatmaps**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s3.a_list_of_heatmaps.html) |
|
116 | 116 |
|
117 | 117 |
This vignette introduces how to concatenate a list of heatmaps and how adjustment is applied to keep |
118 | 118 |
the correspondence of the heatmaps. |
119 | 119 |
|
120 |
- 3. [**Heatmap Annotations**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s4.heatmap_annotation.html) |
|
120 |
+ 3. [**Heatmap Annotations**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s4.heatmap_annotation.html) |
|
121 | 121 |
|
122 | 122 |
This vignette introduces the concept of the heatmap annotation and demonstrate how to make simple annotations |
123 | 123 |
as well as complex annotations. Also, the vignette explains the difference between column annotations |
124 | 124 |
and row annotations. |
125 | 125 |
|
126 |
- 4. [**Heatmap and Annotation Legends**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s5.legend.html) |
|
126 |
+ 4. [**Heatmap and Annotation Legends**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s5.legend.html) |
|
127 | 127 |
|
128 | 128 |
This vignette introduces how to configurate the heatmap legend and annotation legend, also |
129 | 129 |
how to add self-defined legends. |
130 | 130 |
|
131 |
- 5. [**Heatmap Decoration**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s6.heatmap_decoration.html) |
|
131 |
+ 5. [**Heatmap Decoration**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s6.heatmap_decoration.html) |
|
132 | 132 |
|
133 | 133 |
This vignette introduces methods to add more self-defined graphics to the heatmaps after the heatmaps |
134 | 134 |
are generated. |
135 | 135 |
|
136 |
- 6. [**Interactive with Heatmaps**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s7.interactive.html) |
|
136 |
+ 6. [**Interactive with Heatmaps**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s7.interactive.html) |
|
137 | 137 |
|
138 | 138 |
How to select a region in the heatmap to retrieve the sub-matrix. |
139 | 139 |
|
140 |
- 7. [**OncoPrint**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s8.oncoprint.html) |
|
140 |
+ 7. [**OncoPrint**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s8.oncoprint.html) |
|
141 | 141 |
|
142 | 142 |
How to make an oncoPrint. |
143 | 143 |
|
144 |
- 8. [**Examples**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s9.examples.html) |
|
144 |
+ 8. [**Examples**](http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s9.examples.html) |
|
145 | 145 |
|
146 | 146 |
More simulated and real-world examples are shown in this vignette. |
147 | 147 |
|
... | ... |
@@ -3,23 +3,40 @@ |
3 | 3 |
Make Complex Heatmaps |
4 | 4 |
========================= |
5 | 5 |
|
6 |
-Complex heatmaps are efficient to visualize associations between different sources of data sets and reveal potential features. Here the ComplexHeatmap package provides a highly flexible way to arrange multiple heatmaps and supports self-defined annotation graphics. |
|
6 |
+Complex heatmaps are efficient to visualize associations |
|
7 |
+between different sources of data sets and reveal potential structures. |
|
8 |
+Here the **ComplexHeatmap** package provides a highly flexible way to arrange |
|
9 |
+multiple heatmaps and supports self-defined annotation graphics. |
|
7 | 10 |
|
8 |
-A single heatmap or a list of heatmaps are composed by basic components: |
|
11 |
+## General design |
|
12 |
+ |
|
13 |
+Generally, a heatmap list contains several heatmaps and row annotations. |
|
9 | 14 |
|
10 | 15 |
 |
11 | 16 |
|
12 |
-The package makes heatmaps in an object-oriented way by abstracting heatmaps into several classes: |
|
17 |
+Surrounding the heatmap list, |
|
18 |
+there are legends for heatmaps and annotations, also there are titles which are placed |
|
19 |
+on the four sides of the heatmap list. And for each heatmap, there are also different components |
|
20 |
+surrounding the heatmap body. |
|
21 |
+ |
|
22 |
+The **ComplexHeatmap** package is implemented in an object-oriented way. To describe a heatmap list, |
|
23 |
+there are following classes: |
|
24 |
+ |
|
25 |
+- `Heatmap` class: a single heatmap containing heatmap body, row/column names, titles, dendrograms and column annotations. |
|
26 |
+- `HeatmapList` class: a list of heatmaps and row annotations. |
|
27 |
+- `HeatmapAnnotation` class: defines a list of row annotations and column annotations. |
|
13 | 28 |
|
14 |
-- `Heatmap` a single heatmap |
|
15 |
-- `HeatmapList` a list of heatmaps |
|
16 |
-- `HeatmapAnnotation` annotation on columns or rows |
|
29 |
+There are also several internal classes: |
|
17 | 30 |
|
18 |
-and provides methods for arranging and plotting heatmap components. |
|
31 |
+- `SingleAnnotation` class: defines a single row annotation or column annotation. |
|
32 |
+- `ColorMapping` class: mapping from values to colors. |
|
19 | 33 |
|
20 |
-## Install |
|
34 |
+**ComplexHeatmap** is implemented under **grid** system, so users should know basic **grid** functionality |
|
35 |
+to get full use of the package. |
|
21 | 36 |
|
22 |
-`ComplexHeatmap` is available on Bioconductor, you can intall it by: |
|
37 |
+### Install |
|
38 |
+ |
|
39 |
+`ComplexHeatmap` is available on [Bioconductor](http://www.bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html), you can intall it by: |
|
23 | 40 |
|
24 | 41 |
```{r} |
25 | 42 |
source("http://bioconductor.org/biocLite.R") |
... | ... |
@@ -33,7 +50,7 @@ library(devtools) |
33 | 50 |
install_github("jokergoo/ComplexHeatmap") |
34 | 51 |
``` |
35 | 52 |
|
36 |
-## Usage |
|
53 |
+### Usage |
|
37 | 54 |
|
38 | 55 |
Make a single heatmap: |
39 | 56 |
|
... | ... |
@@ -61,14 +78,75 @@ ha = HeatmapAnnotation(df = anno1, anno_fun = anno2, ..., which = "row") |
61 | 78 |
Heatmap(mat1, ...) + Heatmap(mat2, ...) + ha |
62 | 79 |
``` |
63 | 80 |
|
64 |
-## As a base package |
|
81 |
+### As a base package |
|
65 | 82 |
|
66 | 83 |
**ComplexHeatmap** can be used as a base package to build other packages which focus |
67 | 84 |
On specific applications. E.g. [EnrichedHeatmap](http://github.com/jokergoo/EnrichedHeatmap) package |
68 | 85 |
uses **ComplexHeatmap** as base to make heatmaps which visualize the enrichment of genomic signals |
69 | 86 |
to specific target regions. |
70 | 87 |
|
71 |
-## Visualize high dimensional genomic data |
|
88 |
+### Vignettes |
|
89 |
+ |
|
90 |
+There are several vignettes in the package. Each vignette focuses on a specific topic. Following |
|
91 |
+lists the general topics discussed in these vignettes: |
|
92 |
+ |
|
93 |
+ 1. [**Making a Single Heatmap**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s2.single_heatmap.html) |
|
94 |
+ |
|
95 |
+ This vignette introduces the basic configuration for making a single heatmap. Similar as other |
|
96 |
+ R functions/packages, the basic usage is quite similar, but there are several unique features |
|
97 |
+ for **ComplexHeamtap** package. |
|
98 |
+ - Works both for numeric matrix and character matrix |
|
99 |
+ - For numeric matrix which contains continuous values, the package allows a color mapping function |
|
100 |
+ which can give more accurate colors and be robust to outliers. |
|
101 |
+ - Highly flexible for clustering. You can define the distance method for clustering by: |
|
102 |
+ * a pre-defined distance such as "euclidean" or "pearson" |
|
103 |
+ * a self-defined function which calculates distance from a matrix. |
|
104 |
+ * a self-defined function which calculates distance from two vectors |
|
105 |
+ |
|
106 |
+ You can define the clustering method by: |
|
107 |
+ * a clustering function such as `diana()` from **cluster** package |
|
108 |
+ * a `hclust` or `dendrogram` object. |
|
109 |
+ - `NA` is allowed for clustering and heatmap visualization. |
|
110 |
+ - Dendrogram and dimension names can be put on any side of the heatmap. |
|
111 |
+ - Rows on the heatmap can be split by `cutree`, by `kmeans` or by a data frame which contains |
|
112 |
+ different levels that split the heatmap. |
|
113 |
+ - The heatmap body itself can be completely self-defined. |
|
114 |
+ |
|
115 |
+ 2. [**Making a List of Heatmaps**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s3.a_list_of_heatmaps.html) |
|
116 |
+ |
|
117 |
+ This vignette introduces how to concatenate a list of heatmaps and how adjustment is applied to keep |
|
118 |
+ the correspondence of the heatmaps. |
|
119 |
+ |
|
120 |
+ 3. [**Heatmap Annotations**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s4.heatmap_annotation.html) |
|
121 |
+ |
|
122 |
+ This vignette introduces the concept of the heatmap annotation and demonstrate how to make simple annotations |
|
123 |
+ as well as complex annotations. Also, the vignette explains the difference between column annotations |
|
124 |
+ and row annotations. |
|
125 |
+ |
|
126 |
+ 4. [**Heatmap and Annotation Legends**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s5.legend.html) |
|
127 |
+ |
|
128 |
+ This vignette introduces how to configurate the heatmap legend and annotation legend, also |
|
129 |
+ how to add self-defined legends. |
|
130 |
+ |
|
131 |
+ 5. [**Heatmap Decoration**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s6.heatmap_decoration.html) |
|
132 |
+ |
|
133 |
+ This vignette introduces methods to add more self-defined graphics to the heatmaps after the heatmaps |
|
134 |
+ are generated. |
|
135 |
+ |
|
136 |
+ 6. [**Interactive with Heatmaps**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s7.interactive.html) |
|
137 |
+ |
|
138 |
+ How to select a region in the heatmap to retrieve the sub-matrix. |
|
139 |
+ |
|
140 |
+ 7. [**OncoPrint**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s8.oncoprint.html) |
|
141 |
+ |
|
142 |
+ How to make an oncoPrint. |
|
143 |
+ |
|
144 |
+ 8. [**Examples**](http://http://www.bioconductor.org/packages/devel/bioc/vignettes/ComplexHeatmap/inst/doc/s9.examples.html) |
|
145 |
+ |
|
146 |
+ More simulated and real-world examples are shown in this vignette. |
|
147 |
+ |
|
148 |
+ |
|
149 |
+### Visualize high dimensional genomic data |
|
72 | 150 |
|
73 | 151 |
The examples visualizes correlation between methylation and expression, as well as other annotation information (data are randomly generated). In the heatmap, each row corresponds to a differentially methylated regions (DMRs). |
74 | 152 |
From left to right, heatmaps are: |
... | ... |
@@ -84,7 +162,7 @@ From left to right, heatmaps are: |
84 | 162 |
|
85 | 163 |
 |
86 | 164 |
|
87 |
-## OncoPrint |
|
165 |
+### OncoPrint |
|
88 | 166 |
|
89 | 167 |
<a href="http://www.cbioportal.org/faq.jsp#what-are-oncoprints">OncoPrint</a> visualize multiple genomic alteration |
90 | 168 |
events through a heatmap. From verion 1.3.0, **ComplexHeatmap** package provides a new `oncoPrint()` function. By this |
... | ... |
@@ -96,8 +174,8 @@ oncoPrint to enphasize sub groups. |
96 | 174 |
|
97 | 175 |
 |
98 | 176 |
|
99 |
-## Interact with heatmaps |
|
177 |
+### Interact with heatmaps |
|
100 | 178 |
|
101 | 179 |
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 | 180 |
|
103 |
- |
|
181 |
+<p><img src="https://cloud.githubusercontent.com/assets/449218/10479344/2981c27a-7264-11e5-9868-7400c5dc620d.gif", width="600"></p> |
git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@109609 bc3139a8-67e5-0310-9ffc-ced21a209358
... | ... |
@@ -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 |
+ |
git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@108253 bc3139a8-67e5-0310-9ffc-ced21a209358
git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@108252 bc3139a8-67e5-0310-9ffc-ced21a209358
... | ... |
@@ -82,7 +82,7 @@ From left to right, heatmaps are: |
82 | 82 |
7. distance from the DMR to the TSS of the corresponding gene. |
83 | 83 |
8. overlapping between DMRs and enhancers (Color shows how much the DMR is covered by the enhancers). |
84 | 84 |
|
85 |
- |
|
85 |
+ |
|
86 | 86 |
|
87 | 87 |
## OncoPrint |
88 | 88 |
|
... | ... |
@@ -95,3 +95,9 @@ With general functionality of **ComplexHeamtap**, you can add more heatmaps / ro |
95 | 95 |
oncoPrint to enphasize sub groups. |
96 | 96 |
|
97 | 97 |
 |
98 |
+ |
|
99 |
+## Interact with heatmaps |
|
100 |
+ |
|
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 |
+ |
|
103 |
+ |
From: Zuguang Gu <jokergoo@gmail.com>
git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@107686 bc3139a8-67e5-0310-9ffc-ced21a209358
... | ... |
@@ -68,16 +68,9 @@ On specific applications. E.g. [EnrichedHeatmap](http://github.com/jokergoo/Enri |
68 | 68 |
uses **ComplexHeatmap** as base to make heatmaps which visualize the enrichment of genomic signals |
69 | 69 |
to specific target regions. |
70 | 70 |
|
71 |
-## Examples |
|
71 |
+## Visualize high dimensional genomic data |
|
72 | 72 |
|
73 |
- |
|
74 |
-The first examples is <a href="http://www.cbioportal.org/faq.jsp#what-are-oncoprints">OncoPrint</a>. |
|
75 |
-The basic idea is to self define the heatmap body. Besides the default style which is |
|
76 |
-provided by <a href="http://www.cbioportal.org/index.do">cBioPortal</a>, there are |
|
77 |
-additional barplots at both sides of the heatmap which show numbers of different alterations for |
|
78 |
-each sample and for each gene. |
|
79 |
- |
|
80 |
-The second examples visualizes correlation between methylation and expression, as well as other annotation information (data are randomly generated). In the heatmap, each row corresponds to a differentially methylated regions (DMRs). |
|
73 |
+The examples visualizes correlation between methylation and expression, as well as other annotation information (data are randomly generated). In the heatmap, each row corresponds to a differentially methylated regions (DMRs). |
|
81 | 74 |
From left to right, heatmaps are: |
82 | 75 |
|
83 | 76 |
1. methylation for each DMRs in samples. |
... | ... |
@@ -90,3 +83,15 @@ From left to right, heatmaps are: |
90 | 83 |
8. overlapping between DMRs and enhancers (Color shows how much the DMR is covered by the enhancers). |
91 | 84 |
|
92 | 85 |
 |
86 |
+ |
|
87 |
+## OncoPrint |
|
88 |
+ |
|
89 |
+<a href="http://www.cbioportal.org/faq.jsp#what-are-oncoprints">OncoPrint</a> visualize multiple genomic alteration |
|
90 |
+events through a heatmap. From verion 1.3.0, **ComplexHeatmap** package provides a new `oncoPrint()` function. By this |
|
91 |
+function, users can define their own graphics which correspond to differnet alteration events. Also the function additionally |
|
92 |
+add barplots on two sides of the heatmap which tell number of different alterations in patients or samples. |
|
93 |
+ |
|
94 |
+With general functionality of **ComplexHeamtap**, you can add more heatmaps / row annotations to the oncoPrint, even split the |
|
95 |
+oncoPrint to enphasize sub groups. |
|
96 |
+ |
|
97 |
+ |
Commit id: ebfb532213558d3f941133ed7ac85bd3510c7a59
Update README.md
git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/ComplexHeatmap@105394 bc3139a8-67e5-0310-9ffc-ced21a209358