metagene2_heatmap {metagene2}R Documentation

Plots a heatmap of coverages from a metagene2 object.

Description

This function creates an ordering of regions within region groups based on ascending or descending mean coverage. This is used with the metagene2_heatmap function.

Usage

metagene2_heatmap(
  metagene,
  region_order = as_is_region_order(metagene),
  scale_trans = "identity"
)

Arguments

metagene

The metagene object to be plotted as a heatmap.

region_order

A named list with as many elements as there are region groups, with each element containing an ordering for the regions within that group. The as_is_region_order and coverage_order functions can be used to generate a valid ordering. By default, as_is_region_order is used.

scale_trans

A character string giving the transformation that should be applied to the coverage values. Common values are "identity" and "log1p". See the ggplot2 documentation for scale_continuous for more details.

Value

A ggplot object containing a heatmap representation of the metagene2 object.

Examples

  demo_metagene = get_demo_metagene()
  metagene2_heatmap(demo_metagene)

[Package metagene2 version 1.10.0 Index]