https://github.com/rlbarter/superheat

An r package for generating beautiful and customizable heatmaps
https://github.com/rlbarter/superheat

Last synced: 3 months ago
JSON representation

An r package for generating beautiful and customizable heatmaps

• Host: GitHub
• URL: https://github.com/rlbarter/superheat
• Owner: rlbarter
• Created: 2015-10-24T21:52:18.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-09-07T23:06:22.000Z (about 4 years ago)
• Last Synced: 2024-08-03T23:24:15.189Z (3 months ago)
• Language: R
• Homepage: https://rlbarter.github.io/superheat/
• Size: 125 MB
• Stars: 234
• Watchers: 16
• Forks: 29
• Open Issues: 27
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
---

output: html_document

---

# superheat: An R package for supervised heatmaps

[![Travis-CI Build Status](https://travis-ci.org/rlbarter/superheat.svg?branch=master)](https://travis-ci.org/rlbarter/superheat)

*Superheat* is an R package for generating beautiful and customizable heatmaps. **See the [vignette](https://rlbarter.github.io/superheat/) for usage**.

If you find any bugs, have any feature requests or feedback, please submit an issue.

To download and install the development version of the package, use `devtools`:

```{r, eval = FALSE}

install.packages("devtools")

devtools::install_github("rlbarter/superheat")

```

Once you've installed the package, you can load the library in the standard way:

```{r}

library(superheat)

```

Basic usage:

```{r, fig.height = 9.5, fig.width = 8, fig.align = "center"}

superheat(mtcars,

          # normalize variables

          scale = T,

          # order rows/cols based on heirarchical clustering

          pretty.order.rows = TRUE,

          pretty.order.cols = TRUE,

          # plot miles per gallon next to the rows

          yr = mtcars$mpg,

          yr.axis.name = "miles per gallon",

          # plot correlation with mpg above columns

          yt = cor(mtcars)[, "mpg"],

          yt.plot.type = "bar",

          yt.axis.name = "correlation with mpg",

          # increase size of left labels

          left.label.size = 0.45)

```

![image1](tools/mtcars.png)