writeHeatmap: Wrapper for 'Heatmap()' which allows automatic scaling to...

View source: R/writeHeatmap.R

writeHeatmapR Documentation

Wrapper for Heatmap() which allows automatic scaling to specified cell dimensions and character width, and writes the output to an appropriately sized imge file.

Description

Wrapper for Heatmap() which allows automatic scaling to specified cell dimensions and character width, and writes the output to an appropriately sized imge file.

Usage

writeHeatmap(
  mat,
  filename,
  ...,
  fn = Heatmap,
  conds = NULL,
  left_annotation = NULL,
  cell.h = NULL,
  cell.w = NULL,
  char.h = NULL,
  char.w = NULL,
  height = NULL,
  width = NULL,
  heatmap_height = NULL,
  heatmap_width = NULL,
  units = "in",
  path = ".",
  append.date = F,
  imgfn = dir.pdf,
  buffer.h = 0,
  buffer.w = 0
)

Arguments

mat

A numeric matrix to be plotted.

filename

The output file name.

...

Additional arguments to plotting function.

fn

The plotting function. It should extend ComplexHeatmap::Heatmap()

conds

A matrix of factors to be used as rowAnnotations. Replaces left_annotation.

cell.h

The cell height.

cell.w

The cell width.

char.h

The characther width for column names.

char.w

The character width for row names.

height

The heatmap height. Ignored if cell.h is specified.

width

The heatmap width. Ignored if cell.w is specified.

heatmap_height

The heatmap height. Ignored if cell.h is specified.

heatmap_width

The heatmap width. Ignored if cell.w is specified.

units

The unit scale to be used for cell.h and cell.w.

path

The output directory.

append.date

Whether to write the output to a subdirectory with today's date.

imgfn

The function to write the image. It should extend


kewiechecki/moreComplexHeatmap documentation built on June 8, 2025, 5:18 a.m.