lrr_plot: Prepare log relative risk values for plotting with a...
In gateR: Flow/Mass Cytometry Gating via Spatial Kernel Density Estimation

lrr_plot

R Documentation

Prepare log relative risk values for plotting with a diverging color palette

Internal function to convert an object of class 'im' to values readable by image.plot function within the rrs and lotrrs functions.

lrr_plot(
  input,
  cols,
  midpoint = 0,
  lower_lrr = NULL,
  upper_lrr = NULL,
  digits = 1
)

`input`	An object of class 'rrs' from the `rrs` or `lotrrs` function.
`midpoint`	Numeric. The value to center the diverging color palette.
`lower_lrr`	Numeric. The lower value to concatenate the color key. The default (NULL) uses the minimum value from `input`.
`upper_lrr`	Numeric. The upper value to concatenate the color key. The default (NULL) uses the maximum value from `input`.
`digits`	Integer. The number of significant digits for the labels using the `round` function (default is 1).
`plot_cols`	Character string of length three (3) specifying the colors for plotting: 1) numerator, 2) insignificant, and 3) denominator from the `rrs` or `lotrrs` function.

An object of class 'list'. This is a named list with the following components:

v: An object of class 'SpatRaster' for the estimated gating surface.
cols: An object of class 'vector', returns diverging color palette values.
breaks: An object of class 'vector', returns diverging color palette breaks.
at: An object of class 'vector', returns legend breaks.
labels: An object of class 'vector', returns legend labels.