heatmap: Heatmap of density of high resolution data
In EMSL-Computing/fticRanalysis: Analysis and visualization tools for FT-MS data

heatmap

R Documentation

Heatmap of density of high resolution data

Description

Produces a heatmap showing 2D density for high resolution FTMS data, as an alternative to traditional scatter plots, which may be difficult to understand or render onscreen when there are too many points. This function is used by vanKrevelenPlot and kendrickPlot when the input object contains more than 10^6 cells of data (# samples by # rows).

Usage

heatmap(
  ftmsObj,
  xCName,
  yCName,
  xBreaks = 100,
  yBreaks = 100,
  colorPal = NA,
  title = NA,
  xlabel = NA,
  ylabel = NA,
  mouseovers = TRUE
)

Arguments

`ftmsObj`	an object of class 'peakData' or 'compoundData', typically a result of `as.peakData` or `mapPeaksToCompounds`.
`xCName`	column name for x-axis, must be a column of `ftmsObj$e_data` or `ftmsObj$e_meta`
`yCName`	column name for y-axis, must be a column of `ftmsObj$e_data` or `ftmsObj$e_meta`
`xBreaks`	either a number of breaks (bins) along the x-axis, or a vector of break endpoints
`yBreaks`	either a number of breaks (bins) along the y-axis, or a vector of break endpoints
`colorPal`	color palette function, one of `col_numeric`, `col_factor` or similar `scales` palette function
`title`	plot title
`xlabel`	x axis label, default is `xCName`
`ylabel`	y axis label, default is `yCName`
`mouseovers`	TRUE/FALSE, should mouseovers be constructed? Uses xlabel, ylabel values.