Skip to content

Latest commit

 

History

History
124 lines (70 loc) · 5.85 KB

README.md

File metadata and controls

124 lines (70 loc) · 5.85 KB

heatmaplyExamples

heatmaply status

https://github.com/talgalili/heatmaply/

Build Status codecov.io CRAN_Status_Badge

Please submit examples

This package is still under active development. If you have examples you would like to have added, please submit them at: https://github.com/talgalili/heatmaplyExamples/issues (or fork and open a PR)

Introduction

The heatmaply R package facilitates the creation of interactive heatmaps which allow the inspection of specific value by hovering the mouse over a cell, as well as zooming into a region of the heatmap by dragging a rectangle around the relevant area.

The heatmaplyExamples package hosts examples of using heatmaply on real-world datasets and use-cases. Due to the size of some of the datasets, and resulting vignettes, this package will only be available through this github.

Available examples

The following biological examples are available and fully reproducible from within the package. You may also view them online in the following links (the html files also include the R code for producing the figures):

Reproducing the examples on your own computer

To run the examples from this repo, first install the following packages:

install.packages("plotly")
install.packages('heatmaply')
install.packages('devtools')

# In order to fully replicate the examples here, you will also need to install the following packages:

## try http:// if https:// URLs are not supported
source("https://bioconductor.org/biocLite.R")
biocLite("SummarizedExperiment")     ## R version 2.15 or later
biocLite("biomaRt")     
biocLite("limma")   
biocLite("voom")
biocLite("TCGAbiolinks")
install.packages("tidyverse")
install.packages('glmnet')

And then you may install/load the package using (this may take a bit, since the package is several tens of megabytes):

devtools::install_github("talgalili/heatmaplyExamples", build_vignettes = TRUE)

# if fetching the repo, you can also use:
# devtools::build_vignettes()

Finally, you may browse the vignettes using:

# tools::pkgVignettes("heatmaplyExamples")
# tools::buildVignettes("heatmaplyExamples")
library("heatmaplyExamples")
browseVignettes("heatmaplyExamples")

Acknowledgements

This package is thanks to the amazing work done by MANY people in the open source community. Beyond the many people working on the pipeline of R, thanks should go to the people working on ggplot2 (Hadley Wickham, etc.) and plotly (Carson Sievert, etc.). Also, many of the design elements were inspired by the work done on heatmap, heatmap.2 and d3heatmap, so special thanks goes to the R core team, Gregory R. Warnes, and Joe Cheng from RStudio. The dendrogram side of the package is based on the work in dendextend, in which special thanks should go to Andrie de Vries for his original work on bringing dendrograms to ggplot2 (which evolved into the richer ggdend objects, as implemented in dendextend).

The work on heatmaply was done by Tal Galili, Alan O'Callaghan, and Jonathan Sidi (mostly on shinyHeatmaply).

Funding: This work was supported in part by the European Union Seventh Framework Programme (FP7/2007-2013) under grant agreement no. 604102 (Human Brain Project).

Contact

You are welcome to:

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.