Additional Tools for Developing Spatially Explicit Discrete Event Simulation (SpaDES) Models

[Up] [Top]

Documentation for package ‘SpaDES.tools’ version 1.0.1

Help Pages

SpaDES.tools-package Categorized overview of the 'SpaDES.tools' package
.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.
.pointDistance Alternative point distance (and direction) calculations
adj Fast 'adjacent' function, and Just In Time compiled version
agentLocation 'SELES' - Agent Location at initiation
cir Identify pixels in a circle or ring (donut) 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.
crw Move
crw-method Move
distanceFromEachPoint Calculate distances and directions between many points and many grid cells
duplicatedInt Rcpp duplicated on integers using Rcpp Sugar
dwrpnorm2 Vectorized wrapped normal density function
fastCrop 'fastCrop' is a wrapper around 'velox::VeloxRaster_crop', though 'raster::crop' is faster under many tests.
gaussMap Produce a 'raster' of a random Gaussian process.
heading Heading between spatial points.
heading-method Heading between spatial points.
initiateAgents 'SELES' - Initiate agents
initiateAgents-method 'SELES' - Initiate agents
inRange Test whether a number lies within range [a,b]
mergeRaster Split and re-merge 'RasterLayer'(s)
mergeRaster-method Split and re-merge 'RasterLayer'(s)
middlePixel Return the (approximate) middle pixel on a raster
move Move
neutralLandscapeMap Produce a neutral landscape using a midpoint displacement algorithm
numAgents SELES - Number of Agents to initiate
patchSize Patch size
pointDistance Alternative point distance (and direction) calculations
probInit 'SELES' - Probability of Initiation
randomPolygon Produce a 'RasterLayer' of random polygons
randomPolygon.matrix Produce a 'RasterLayer' of random polygons
randomPolygon.SpatialPoints Produce a 'RasterLayer' of random polygons
randomPolygon.SpatialPolygons Produce a 'RasterLayer' of random polygons
randomPolygons Produce a 'RasterLayer' of random polygons
randomStudyArea Create default study areas for use with 'SpaDES' modules
rasterizeReduced Convert reduced representation to full raster
rings Identifies all cells within a ring around the focal cells
rings-method Identifies all cells within a ring around the focal cells
runifC Rcpp Sugar version of runif
SpaDES.tools Categorized overview of the 'SpaDES.tools' package
specificNumPerPatch Initiate a specific number of agents in a map of patches
splitRaster Split and re-merge 'RasterLayer'(s)
splitRaster-method Split and re-merge 'RasterLayer'(s)
spokes Identify outward radiating spokes from initial points
spokes-method Identify outward radiating spokes from initial points
spread Simulate a spread process on a landscape.
spread-method 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
transitions 'SELES' - Transitioning to next time step
wrap Wrap coordinates or pixels in a torus-like fashion
wrap-method Wrap coordinates or pixels in a torus-like fashion