heatmap.gottgens: Heatmap helper function for leaf re-ordering

Description Usage Arguments Details Value Author(s)

View source: R/heatmap.R

Description

Heatmap helper function for leaf re-ordering

Usage

1
2
3
4
5
6
7
heatmap.gottgens(x, cor.method = "spearman", clust.method = "ward.D2",
  distfun = NULL, col = NULL, breaks = NULL, reorder = c("both", "row",
  "column", "none"), Rowv = NULL, Colv = NULL, scale = c("none", "row",
  "column"), trace = "none", key.cex = 0.4, ColSideColAxis = 4,
  symbreaks = FALSE, margins = c(3, 3), cexRow = 0.6, keysize = 0.5,
  key.title = "Key", key.par = list(mar = c(2.5, 0.5, 1.5, 0.5)),
  density.info = "none", ...)

Arguments

x

Matrix

cor.method

method to be used to calculate distance. Default is (1 - spearman rank correlation). This is overridden by distfun.

clust.method

clustering method to be used. Default is ward.D2

distfun

function to use for distance calculation.

col

define colour. If defines please ensure that breaks are passed to heatmap.minus.

breaks

colour breaks.

reorder

Logical whether to reorder leaves

Rowv

determines if and how the row dendrogram should be reordered. By default, it is TRUE, which implies dendrogram is computed and reordered based on row means. If NULL or FALSE, then no dendrogram is computed and no reordering is done. If a dendrogram, then it is used "as-is", ie without any reordering. If a vector of integers, then dendrogram is computed and reordered based on the order of the vector.

Colv

determines if and how the column dendrogram should be reordered. Has the options as the Rowv argument above and additionally when x is a square matrix, Colv = Rowv means that columns should be treated identically to the rows.

scale

Scale by "row", "column" or "none"

trace

character string indicating whether a solid "trace" line should be drawn across 'row's or down 'column's, 'both' or 'none'. The distance of the line from the center of each color-cell is proportional to the size of the measurement. Defaults to 'column'.

key.cex

size of key text

ColSideColAxis

changes axis on which the group names are printed. Use 2 for left and 4 for right.

symbreaks

Boolean indicating whether breaks should be made symmetric about 0. Defaults to TRUE if the data includes negative values, and to FALSE otherwise.

margins

numeric vector of length 2 containing the margins (see par(mar= *)) for column and row names, respectively.

cexRow

positive numbers, used as cex.axis in for the row or column axis labeling. The defaults currently only use number of rows or columns, respectively.

keysize

numeric value indicating the size of the key

key.title

character string for the key title

key.par

defines the key's parameters e.g. margins

density.info

character string indicating whether to superimpose a 'histogram', a 'density' plot, or no plot ('none') on the color-key.

...

Parameters passed to heatmap.minus

Details

Heatmap helper function for leaf re-ordering, the Gottgens way.

Value

Calls heatmap.minus and returns list with re-ordering

Author(s)

Wajid Jawaid


wjawaid/bglab documentation built on May 4, 2019, 6:33 a.m.