plotTemporalComparison: Plot a comparison between two Temporal layers

View source: R/plotTemporalComparison.R

plotTemporalComparisonR Documentation

Plot a comparison between two Temporal layers

Description

This function is for plotting maps from Comparison objects (or a list of those Comparisons). Three types of comparisons plots are supported: 'difference' - a difference map; "values" - the absolute values plotted in panels and "percentage.difference" - the percentage differences.

Usage

plotTemporalComparison(
  comparisons,
  type = c("difference", "percentage.difference", "values", "nme"),
  limits = NULL,
  symmetric.scale = TRUE,
  percentage.difference.limit = 300,
  do.phase = FALSE,
  plot.zero.line = TRUE,
  ...
)

Arguments

comparisons

The data to plot, must be a Comparison or a list of Comparisons

type

A character specifying what type of plot to make. Can be "difference" (default, for a difference plot), " percentage.difference", "values" (actual values, side-by-side).

limits

A numeric vector with two members (lower and upper limit) to limit the plotted values.

symmetric.scale

If plotting a differences, make the scale symmetric around zero (default is TRUE)

percentage.difference.limit

If percentage difference to be plotted, what to limit the scale to. Default is 300.

do.phase

Logical, only applies to plotting Comparison objects of type "seasonal".

plot.zero.line

Logical, if TRUE (default) plot a black line at y=0 in difference plots to better guide the eye for If TRUE plot the the seasonal phase, if FALSE (the default), plot the seasonal concentration.

...

Parameters passed to plotTemporal

Details

A wrapper for around plotTemporal to plot the temporal Comparisons as maps. Extra arguments to plotTemporal can also be specified.

Value

Returns a ggplot object

Author(s)

Matthew Forrest matthew.forrest@senckenberg.de

See Also

plotTemporal, compareLayers


MagicForrest/DGVMTools documentation built on Aug. 23, 2024, 8:05 a.m.