Function reference • SpaDES.tools

All functions
`agentLocation()`	`SELES` - Agent Location at initiation
`numAgents()`	SELES - Number of Agents to initiate
`probInit()`	`SELES` - Probability of Initiation
`transitions()`	`SELES` - Transitioning to next time step
`SpaDES.tools` `SpaDES.tools-package`	Categorized overview of the `SpaDES.tools` package
`adj()`	Fast `adjacent` function, and Just In Time compiled version
`cir()`	Identify pixels in a circle or ring (doughnut) around an object.
`.cirSpecialQuick()`	This is a very fast version of `cir` with `allowOverlap = TRUE`, `allowDuplicates = FALSE`, `returnIndices = TRUE`, `returnDistances = TRUE`, and `includeBehavior = "excludePixels"`. It is used inside `spread2`, when asymmetry is active. The basic algorithm is to run `cir` just once, then add to the x,y coordinates of every locus.
`move()` `crw()`	Move
`fastCrop()`	`fastCrop` is deprecated.
`distanceFromEachPoint()`	Calculate distances and directions between many points and many grid cells
`.pointDistance()`	Alternative point distance (and direction) calculations
`duplicatedInt()`	Rcpp duplicated on integers using Rcpp Sugar
`dwrpnorm2()`	Vectorized wrapped normal density function
`gaussMap()`	Produce a `raster` of a random Gaussian process.
`heading()`	Heading between spatial points.
`inRange()`	Test whether a number lies within range `[a,b]`
`initiateAgents()`	`SELES` - Initiate agents
`middlePixel()`	Return the (approximate) middle pixel on a raster
`neutralLandscapeMap()`	Produce a neutral landscape using a midpoint displacement algorithm
`patchSize()`	Patch size
`randomPolygons()` `randomPolygon()`	Produce a `SpatRaster` of random polygons
`randomStudyArea()`	Create default study areas for use with `SpaDES` modules
`rasterizeReduced()`	Convert reduced representation to full raster
`runifC()`	Rcpp Sugar version of runif
`rings()`	Identifies all cells within a ring around the focal cells
`specificNumPerPatch()`	Initiate a specific number of agents in a map of patches
`mergeRaster()` `splitRaster()`	Split and re-merge `RasterLayer`(s)
`spokes()`	Identify outward radiating spokes from initial points
`spread()`	Simulate a spread process on a landscape.
`spread2()`	Simulate a contagious spread process on a landscape, with `data.table` internals
`spread3()`	An alternative spread function, conceived for insects
`testEquivalentMetadata()`	Test that metadata of 2 or more objects is the same
`wrap()`	Wrap coordinates or pixels in a torus-like fashion

Reference

All functions