prepare_heatmap_list: Combine the heatmaps objects

In CharlesJB/heatmaps: What the Package Does (One Line, Title Case)

Combine the heatmaps objects

Description

This function prepare the ready for drawing HeatmapList-class object.

Usage

prepare_heatmap_list(heatmap_list, partitions = character(0), seed = 99841)

Arguments

heatmap_list

The list of Heatmap objects produced with the produce_heatmap function.

partitions

If you want to split the heatmap based on different group, you must specify the groups (or partitions). The partition must be a vector of the same length as the peaks param used when creating the Heatmap objects with the produce_heatmap function. All heatmaps must be produced using the same peaks object. If the vector is empty (i.e.: character(0), the heatmap won't be splitted. Default: character(0).

Value

This function invisibly returns a HeatmapList-class object for which the layout has been created.

Examples

## Not run: 
htl <- get_demo_heatmap_list()
htl <- prepare_heatmap_list(htl)

## End(Not run)

CharlesJB/heatmaps documentation built on Nov. 2, 2023, 10:06 a.m.