plotPeakImageG: plotPeakImageG.

Description Usage Arguments Value

Description

plots and ion map image using the rMSIproc peak matrix. This function is equivalent to the rMSIproc::plotPeakImage but used ggplot to produce more publication-ready results.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
plotPeakImageG(
  peakMatrix,
  mass,
  normalization = NA,
  plot_rows = 2,
  plot_cols = 2,
  plot_byrow = T,
  plot_rotations = rep(0, length(peakMatrix$names)),
  plot_mirror_X = rep(F, length(peakMatrix$names)),
  plot_mirror_Y = rep(F, length(peakMatrix$names)),
  plot_margin = 40,
  plot_labels = peakMatrix$names,
  title_label = "",
  fixed_aspect_ratio = F,
  display_colorbar = T
)

Arguments

peakMatrix

an rMSIproc peak matrix.

mass

the ion mass to be plot.

normalization

a vector containing the normalization value for each pixel or NA if no normalization should be applied.

plot_rows

number of rows of the plotted matrix layout (only used if byrow == F).

plot_cols

number of cols of the plotted matrix layout (only used if byrow == T).

plot_byrow

a bool specifing if images must be arranged in rows.

plot_rotations

a vector with the rotation of each images specified in degrees.

plot_mirror_X

a bool vector specifing if each image must be flipped or not in X direction prior to rotation.

plot_mirror_Y

a bool vector specifing if each image must be flipped or not in Y direction prior to rotation.

plot_margin

the separation between plotted images.

plot_labels

an alternative character vector with the labels to be displayed for each image.

title_label

the main title of the plot

fixed_aspect_ratio

set this flag to true to fix the aspect ratio of the ion images.

display_colorbar

set if the colour bar must be displayed.

Value

a ggplot2 object.


prafols/rMSIproc documentation built on Dec. 12, 2021, 7:31 p.m.