Learn R Programming

⚠️There's a newer version (2.0.11) of this package.Take me there.

SpaDES (version 1.1.1)

Develop and Run Spatially Explicit Discrete Event Simulation Models

Description

Easily implement a variety of simulation models, with a focus on spatially explicit agent based models. These include raster-based, event-based, and agent-based models. The core simulation components are built upon a discrete event simulation framework that facilitates modularity, and easily enables the user to include additional functionality by running user-built simulation modules. Included are numerous tools to visualize raster and other maps. The suggested package `fastshp` can be installed with `install.packages("fastshp", repos="http://rforge.net", type="source")`.

Copy Link

Version

Install

install.packages('SpaDES')

Monthly Downloads

484

Version

1.1.1

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Alex M Chubaty

Last Published

February 16th, 2016

Functions in SpaDES (1.1.1)

.arrangement-class

The .arrangement class
adj.raw

Fast `adjacent` function, and Just In Time compiled version
checkPath

Check filepath.
classFilter

Filter objects by class
transitions

SELES - Transitioning to next time step
.depsPruneEdges

Prune edges to remove cycles in module dependencies
checkObject

Check for existence of object(s) referenced by a objects slot of a simList object
.identifyGrobToPlot

Identify where to get the grob from
makeDigestible

Remove any reference to environments in a simList
.makeColorMatrix

Convert Raster to color matrix useable by raster function for plotting
depsEdgeList

Build edge list for module dependency graph
.emptyMetadata

Default (empty) metadata
times

Time usage in SpaDES
nlayers,list-method

Find the number of layers in a Spatial Object
newModule

Create new module from template.
.parseArgs

Parse arguments and find environments
doEvent.checkpoint

Simulation checkpoints.
clearPlot

Clear plotting device
downloadData

Download module data
cache

Cache method for simList class objects
gpar

Importing some grid functions
doEvent

Process a simulation event
.getSpaDES

Get objects from the internal SpaDES environment
randomPolygons

randomPolygons
.makeLayout

Make an optimal layout of plots
.plotGrob

Plot spatial grobs (using grid package)
initialize,simList-method

Generate a simList object
defineModule

Define a new module.
maxTimeunit

Determine the largest timestep unit in a simulation
.unparsed

Determine which modules in a list are unparsed
.sim2gantt

sim2gantt
defineParameter

Define a parameter used in a module
agentLocation

SELES - Agent Location at initiation
ls.str.simList

List simulation objects and their structure
heading

Heading between spatial points.
.makeList

Convert plotArgs to list of lists
.moduleDeps-class

The .moduleDeps class
spread

Simulate a spread process on a landscape.
splitRaster

Split a raster into multiple tiles.
envir

Simulation environment
ls.simList

List simulation objects
Plot

Plot: Fast, optimally arranged, multipanel plotting function with SpaDES
equalExtent

Assess whether a list of extents are all equal
probInit

SELES - Probability of Initiation
.updateSpadesPlot

Merge two SpaDES Plot objects
ganttStatus

ganttStatus
packages

Get simulation package dependencies
.findFactors

Find factors
objectDiagram

Simulation object dependency diagram
moduleDiagram

Simulation module dependency diagram
gaussMap

Produce a raster of a random Gaussian process.
append_attr

Add a module to a moduleList
wrap

Wrap coordinates or pixels in a torus-like fashion
cir

Identify pixels in a circle around a SpatialPoints* object.
depsGraph

Build a module dependency graph
newPlot

Open a new plotting window
checkParams

Check use and existence of params passed to simulation.
patchSize

Patch size
.makeSpadesPlot

Make a .spadesPlot class object
.first

Event priority
spades

Run a spatial discrete event simulation
show,simList-method

Show an Object
saveFiles

Save objects using .saveObjects in params slot of simInit
digest

Calculate the hashes of multiple files
.depsLoadOrder

Determine module load order
newProgressBar

Progress bar
.inputObjects

Create an empty (template) inputObjects and outputObjects data.frames
.arrangeViewports

Determine optimal plotting arrangement of plot objects
moduleMetadata

Parse and extract module metadata
makeLines

Make SpatialLines object from two SpatialPoints objects
.parseModule

Parse and initialize a module
.simDeps-class

The .simDeps class
changeObjEnv

Copy or move objects from one environment to another
simInit

Initialize a new simulation
divergentColors

Divergent colour palette
params

Get and set simulation parameters.
downloadModule

Download a module from a SpaDES module GitHub repository
.existsSpaDES

Is an object defined in the .spades environment?
.prepareRaster

Prepare raster for plotting
paddedFloatToChar

Convert numeric to character with padding
sortDotsFirst

Sort a any named object with dotted names first
clickValues

Mouse interactions with Plots
inSeconds

Convert time units
dyears

SpaDES time units
inputs

Inputs and outputs
.spadesPlottables-class

The .spadesPlottables class
rndstr

Generate random strings
eventDiagram

Simulation event diagram
setColors<-

Set colours for plotting Raster* objects.
updateList

Update elements of a named list with elements of a second named list
spadesClasses

Classes defined in SpaDES
.spadesGrob-class

The .spadesGrob class
simList_-class

The simList_ class
numAgents

SELES - Number of Agents to initiate
objs

Extract or replace an object from the simulation environment
.unittrim

Convert grid.locator units
move

Move
dev

Specify where to plot
dwrpnorm2

Vectorized wrapped normal density function
.fileTableIn

Create empty fileTable for inputs and outputs
getModuleVersion

Find the latest module version from a SpaDES module repository
events

Simulation event lists
spadesMaps

Dummy maps included with SpaDES
openModules

Open all modules nested within a base directory
spatialObjects-class

The spatialObjects class
.assignSpaDES

Assign to the internal SpaDES environment.
clearStubArtifacts

Clear erroneous archivist artifacts
rasterizeReduced

Convert reduced representation to full raster
layerNames

Extract the layer names of Spatial Objects
.makeViewports

Make viewports
rasterToMemory

Read raster to memory
paths

Specify paths for modules, inputs, and outputs
.spadesPlotObjects-class

The .spadesPlotObjects class
.addDepends

Add simulation dependencies
getFileName

Get the name of a source-ed file
scheduleEvent

Schedule a simulation event
normPath

Normalize filepath
zipModule

Create a zip archive of a module subdirectory
.spadesPlot-class

The .spadesPlot class
.simList-class

The simList class
versionWarning

Compare module version against SpaDES package version and warn if incompatible
SpaDES-package

Categorized overview of the SpaDES package
checkModule

Check for the existence of a remote module
loadPackages

Load packages.
modules

Simulation modules and dependencies
initiateAgents

SELES - Initiate agents
.objectNames

Extracts the object names
loadFiles

Load simulation objects according to filelist
specificNumPerPatch

specificNumPerPatch
checksums

Calculate checksums for a module's data files
getColors

Get colours for plotting Raster* objects.
moduleCoverage

Calculate module coverage of unit tests
inRange

Test whether a number lies within range [a,b]
minTimeunit

Determine the smallest timeunit in a simulation
.spadesEnv

The SpaDES environment