heatmapAlpabet: Draw a customised heatmap where the different variables are...

View source: R/heatmap-wrappers.R

heatmapAlpabetR Documentation

Draw a customised heatmap where the different variables are sorted alphabetically

Description

Draw a customised heatmap where the different variables are sorted alphabetically

Usage

heatmapAlpabet(data, label.A, label.B, out.A, out.B, digits, key,
  col = barzinePhdR::colCbc(), sorting = TRUE, margins, ...,
  report = TRUE, index = "####", annot = "diag")

Arguments

data

correlation (numeric) data.frame to plot

label.A

character string. Name of the first data.frame used for the correlation matrix for the additional text.

label.B

character string. Name of the second data.frame used for the correlation matrix for the additional text.

out.A

character string for the plot (x-axis). Name of the first data.frame used for the correlation matrix

out.B

character string for the plot (y-axis). Name of the second data.frame used for the correlation matrix

digits

integer. default: 1. How many digits should be kept for the annotation.

key

boolean. default: TRUE. Whether the key of the heatmap should also be drawn.

col

color palette to use; default barzinePhdR::colC(), i.e. grDevices::colorRampPalette('aliceblue','darkcyan')

sorting

boolean; default: TRUE. Whether the input data.frame should be rordered alphabetically before being plotted.

margins

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

...

other parameters that can be handled by (gplots) heatmap.2

report

boolean. Default: TRUE. Output additional text (example for an (r)html report)

index

character string. default:"####" Allows to customise the level of indexing through markdown tags.

annot

character string. Default: 'diag'. Annotate only the diagonal of the heatmap with the value of correlation.

Value

a heatmap plot


barzine/barzinePhdR documentation built on Nov. 23, 2024, 8:54 p.m.