50% off: Unlimited data and AI learning.
State of Data and AI Literacy Report 2025

SpaDES (version 1.3.0)

.convertSpatialToPlotGrob: Internal functions used by Plot

Description

Not meant to be used by user.

Usage

.convertSpatialToPlotGrob(grobToPlot, sGrob, takeFromPlotObj, arr, newArr, spadesGrobCounter, subPlots, cols)
".convertSpatialToPlotGrob"(grobToPlot, sGrob, takeFromPlotObj, arr, newArr, spadesGrobCounter, subPlots, cols)
.xyAxes(sGrob, arr, whPlotFrame)
".xyAxes"(sGrob, arr, whPlotFrame)
.Plot(sGrob, grobToPlot, subPlots, spadesSubPlots, spadesGrobCounter, isBaseSubPlot, isNewPlot, isReplot, zMat, wipe, xyAxes, legendText, vps, nonPlotArgs)
".Plot"(sGrob, grobToPlot, subPlots, spadesSubPlots, spadesGrobCounter, isBaseSubPlot, isNewPlot, isReplot, zMat, wipe, xyAxes, legendText, vps, nonPlotArgs)
.refreshGrob(sGrob, subPlots, legendRange, grobToPlot, plotArgs, nColumns, whPlotObj)
".refreshGrob"(sGrob, subPlots, legendRange, grobToPlot, plotArgs, nColumns, whPlotObj)
.updateGrobGPTextAxis(sGrob, arr, newArr)
".updateGrobGPTextAxis"(sGrob, arr, newArr)

Arguments

grobToPlot
Graphical object to plot
sGrob
spadesGrob object
takeFromPlotObj
Logical indicating whether data for grobToPlot should be found in current call to Plot or from disk
arr
An arrangement object
newArr
Logical, whether there is a new arrangement happening
spadesGrobCounter
Numeric. A counter. No meaning outside Plot function.
subPlots
Character. Name of plot area.
cols
Color vector.
whPlotFrame
Numeric. Which plot within the spadesGrobPlots object.
spadesSubPlots
List of many spadesGrobs
isBaseSubPlot
Logical. Is the currently being plotted object a base layer
isNewPlot
Logical. Is the currenly being plotted object a new, additional plot
isReplot
Logical. Is the currently being plotted object a replot due to something like a rearrangement
zMat
List resulting from .convertSpatialToPlotGrob
wipe
Logical. Is the currently being plotted object require a white rectangle to be plotted first, and subsequent other changes.
xyAxes
List of length 2, resulting from .xyAxes
legendText
Character vector of legend value labels. Defaults to NULL, which results in a pretty numeric representation. If Raster* has a Raster Attribute Table (rat; see raster package), this will be used by default. Currently, only a single vector is accepted. The length of this must match the length of the legend, so this is mosty useful for discrete-valued rasters.
vps
A viewport tree resulting from .makeViewports
nonPlotArgs
Arguments passed to Plot that are not .spadesPlottables, but are passed along with .spadesPlottables.
legendRange
Numeric vector giving values that, representing the lower and upper bounds of a legend (i.e., 1:10 or c(1,10) will give same result) that will override the data bounds contained within the grobToPlot.
plotArgs
list. Any arguments that the the grid package can accept for the specific grob types, e.g., rasterGrob, polygonGrob, etc.
nColumns
Numeric, length 1, indicating how many columns are in the device arrangement
whPlotObj
Numeric. Length 1, indicating which of the currently objects passed into Plot is currently being plotted, i.e., a counter of sorts.