addHeatMap {treekoR} | R Documentation

## Title

### Description

a function to add a heatmap of cluster medians alongisde the phylogenetic tree

### Usage

    addHeatMap(
      p,
      cluster_medians,
      offset = 0.5,
      width = 1,
      expand_y_lim = 20,
      low = "#313695",
      mid = "ivory",
      high = "#A50026",
      colnames_angle = 90,
      metric_name = "Column z-score"
    )

### Arguments

`p` | a phylogenetic tree plot created from the ggtree() function
`cluster_medians` | a dataframe with the cluster medians. The rownumbers of the clusters median data frame should correspond to the nodes in the phylo tree. The column names should also correspond to the labels you want to use
`offset` | the distance between the tree plot and heatmap
`width` | width of each tile in the heatmap
`expand_y_lim` | white space below heatmap
`low` | colour used for low values on heatmap
`mid` | colour used for medium values on heatmap
`high` | colour used for large values on heatmap
`colnames_angle` | angle for x-axis label
`metric_name` | legend title

### Value

an interactive ggplot graph object with heatmap of median cluster expressions plotted alongside hierarchical tree

[Package treekoR version 1.2.1 Index]