Learn R
ComplexHeatmap (version 1.10.2)

make_layout-HeatmapList-method: Make layout for the complete plot

Description

Make layout for the complete plot

Usage

## S3 method for class 'HeatmapList':
make_layout(object, row_title = character(0),
    row_title_side = c("left", "right"),
    row_title_gp = gpar(fontsize = 14),
    column_title = character(0),
    column_title_side = c("top", "bottom"),
    column_title_gp = gpar(fontsize = 14),
    heatmap_legend_side = c("right", "left", "bottom", "top"),
    show_heatmap_legend = TRUE,
    heatmap_legend_list = list(),
    annotation_legend_side = c("right", "left", "bottom", "top"),
    show_annotation_legend = TRUE,
    annotation_legend_list = list(),
    gap = unit(3, "mm"),
    main_heatmap = which(sapply(object@ht_list, inherits, "Heatmap"))[1],
    row_dend_side = c("original", "left", "right"),
    row_hclust_side = row_dend_side,
    row_sub_title_side = c("original", "left", "right"))

Arguments

object
a HeatmapList-class object.
row_title
title on the row.
row_title_side
will the title be put on the left or right of the heatmap.
row_title_gp
graphic parameters for drawing text.
column_title
title on the column.
column_title_side
will the title be put on the top or bottom of the heatmap.
column_title_gp
graphic parameters for drawing text.
heatmap_legend_side
side of the heatmap legend.
show_heatmap_legend
whether show heatmap legend.
heatmap_legend_list
a list of self-defined legend, should be wrapped into grob objects.
annotation_legend_side
side of annotation legend.
show_annotation_legend
whether show annotation legend.
annotation_legend_list
a list of self-defined legend, should be wrapped into grob objects.
gap
gap between heatmaps, should be a unit object.
main_heatmap
name or index for the main heatmap
row_dend_side
if auto adjust, where to put the row dendrograms for the main heatmap
row_hclust_side
deprecated, use row_dend_side instead
row_sub_title_side
if auto adjust, where to put sub row titles for the main heatmap

Value

Details

It sets the size of each component of the heatmap list and adjusts graphic parameters for each heatmap if necessary.

The layout for the heatmap list and layout for each heatmap are calculated when drawing the heatmap list.

This function is only for internal use.

Examples

Run this code
# no example for this internal method
NULL

Run the code above in your browser using DataCamp Workspace