plotHeatmapList: Plot a list of heatmaps

Description Usage Arguments Value See Also Examples

View source: R/PlotHeatmapList.R

Description

Plot a list of heatmaps

Usage

1
2
plotHeatmapList(heatmap_list, groups = 1:length(heatmap_list),
  options = heatmapOptions(), ...)

Arguments

heatmap_list

A list of Heatmaps

groups

Optionally group heatmaps together

options

Heatmap options

...

Additional options

This function takes a list of one or more heatmaps and plots them to a single image tiled horizontally.

The "groups" argument specifies heatmaps to be grouped together and plotted using the same display parameters and a unified scale. plotHeatmapList will try to guess the best scale, either starting or finishing at zero, or symetrical aronud zero - if this is not the desired behaviour, make sure the scales are identical before the heatmaps are passed to the function.

Options are specified as for plotHeatmap, but can be specified per group by passing a list of options instead of a single vector. Note the difference between a length-2 character vector, c("Reds", "Blues"), and a list contatining two length-1 character vectors: list("Reds", "Blues").

These are generally large, complex plots, so it can better to plot straight to a file. PNG is preferred since pdf files generated can be if the images are not downsized. The default settings are designed for plots of about 10cm x 20cm per heatmap, but all of the relevant settigns can be tweaked using the options. For display-quality images, it helps to increase the resolution at to at least 150ppi, double the default of 72ppi on most systems.

Value

invisible(0)

See Also

plotHeatmap heatmapOptions plot_legend

Examples

1
2
data(HeatmapExamples)
plotHeatmapList(list(hm, hm2), groups=c(1,2), color=list("Reds", "Blues"))

Example output

Attaching package:heatmapsThe following object is masked frompackage:base:

    scale

plotting heatmap Test
plotting heatmap Test2

heatmaps documentation built on Nov. 8, 2020, 7:32 p.m.