create_heatmap: Method for heatmap creation

Description Usage Arguments Details Value

View source: R/function.R

Description

Method for heatmap creation

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
create_heatmap(
  data,
  unitlabel = "auto",
  row.label = TRUE,
  row.custom.label = NULL,
  column.label = TRUE,
  column.custom.label = NULL,
  clustering = "none",
  clustdist = "auto",
  clustmethod = "auto",
  colors = NULL,
  winsorize.colors = NULL,
  plot.method = "static",
  width = "auto",
  height = "auto",
  ppi = 72,
  scale = 1
)

Arguments

data

data.table containing plot data. First column contains row labels.

unitlabel

label of the colorbar

row.label

Logical whether or not to show row labels.

row.custom.label

Vector of custom row labels.

column.label

Logical whether or not to show column labels.

column.custom.label

Vector of custom column labels.

clustering

How to apply clustering on data. c("none", "both", "column", "row")

clustdist

Which cluster distance to use. See heatmapr.

clustmethod

Which cluster method to use. See heatmapr.

colors

Vector of colors used for color palette.

winsorize.colors

NULL or a vector of length two, giving the values of colorbar ends (default = NULL).

plot.method

Choose which method is used for plotting. Either "plotly" or "complexHeatmap" (Default = "complexHeatmap").

width

Set width of plot in cm (Default = "auto").

height

Set height of plot in cm (Default = "auto").

ppi

Pixel per inch (default = 72).

scale

Modify plot size while preserving aspect ratio (Default = 1).

Details

Width/ height limit = 500. If exceeded default to 500 and issue exceed_size = TRUE.

Value

Returns list(plot = complexHeatmap/ plotly object, width = width in cm, height = height in cm, ppi = pixel per inch, exceed_size = Boolean whether width/ height exceeded max) depending on plot.method.


loosolab/wilson documentation built on Nov. 16, 2021, 3:21 p.m.