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


[Up] [Top]

Documentation for package ‘SpaDES.tools’ version 0.1.1

Help Pages

SpaDES.tools-package Categorized overview of the 'SpaDES.tools' package
%fin% A faster '%in%' based on fastmatch package
.cirSpecialQuick This is a very fast version of cir with allowOverlap = TRUE, allowDuplicates = FALSE, returnIndices = TRUE, returnDistancse = TRUE, and includeBehaviour = "excludePixels". It is used inside spread2, when asymmetry is active. The basic algorithm is to run cir just once, then add to the xy coordinates of every locus
adj Fast 'adjacent' function, and Just In Time compiled version
adj.raw 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, returnDistancse = TRUE, and includeBehaviour = "excludePixels". It is used inside spread2, when asymmetry is active. The basic algorithm is to run cir just once, then add to the xy coordinates of every locus
crw Move
crw-method Move
duplicatedInt Rcpp duplicated on integers using Rcpp Sugar
extractFromArchive Extract files from archive.
fastCrop fastCrop
fastMask Faster operations on rasters
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]'
match A faster '%in%' based on fastmatch package
mergeRaster Split and re-merge RasterLayer(s)
mergeRaster-method Split and re-merge RasterLayer(s)
move Move
numAgents SELES - Number of Agents to initiate
patchSize Patch size
prepInputs Download and optionally reproject, crop, mask raw data and output module inputs
probInit 'SELES' - Probability of Initiation
randomPolygon randomPolygons
randomPolygons randomPolygons
rasterizeReduced Convert reduced representation to full raster
resample Adapted directly from the 'sample' help file.
resampleZeroProof Adapted directly from the 'sample' help file.
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
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