plotHeatmapComparison {paleoAM} | R Documentation |
Plots a Heatmap Comparison
Description
This function is a complex wrapper of the functions contour
and filled.contour
which allows a user to combine colored contours for the surface of a third variables plotted across a two-dimensional space, with contour lines of the third variable's surface also plotted in that same two-dimensional space. This is often a common plotting need for this package, and thus is included here.
Usage
plotHeatmapComparison(
x,
y,
z,
xlim = range(x, finite = TRUE),
ylim = range(y, finite = TRUE),
zlim = range(z, finite = TRUE),
xlog = FALSE,
ylog = FALSE,
xtick = pretty(x),
ytick = pretty(y),
contourLevels = NULL,
nlevels = 10,
contourLineLevels = NULL,
contour.lwd = 2,
additionalFeatures = NULL,
palette = "plasma",
xlab = "x",
ylab = "y",
main = "main title",
gradientKeyLabel = "color gradient key",
mtext_line = 3,
margins = c(5, 6, 5, 5)
)
Arguments
x , y |
The horizontal ( |
z |
The values of the third variable ( |
xlim , ylim , zlim |
These are two-element vectors giving the minimum and maximum limits for the horizontal variable ( |
xlog , ylog |
Should the |
xtick , ytick |
Vectors that give the positions of the tick-marks for |
contourLevels |
A vector of values at which to put the breaks between the color-filled contours for |
nlevels |
The number of different color levels to use, if |
contourLineLevels |
A vector of values at which to put the distinct contour lines for |
contour.lwd |
The thickness of plotted contour lines. |
additionalFeatures |
Additional features to add to the contour space, such as |
palette |
The color palette to use for |
xlab , ylab |
The labels for the |
main |
The plot's main title. |
gradientKeyLabel |
The optional label text for the color gradient key for |
mtext_line |
The distant in the margin away from the key at which the |
margins |
The size of the margins for the result plot. The default configuration gives some extra room on the left-hand size. |
Details
The function filled.contour
doesn't easy allow for sequential modifications, like adding additional contour lines to an existing contour plot, and so this function simplifies having to write the second contour
plot as an argument for plot.axes
in filled.contour
.
Value
This function returns nothing at all as output. It just makes a plot.