Learn R Programming

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

SpaDES (version 1.1.0)

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

331

Version

1.1.0

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Alex M Chubaty

Last Published

January 26th, 2016

Functions in SpaDES (1.1.0)

classFilter

Filter objects by class
getFileName

Get the name of a source-ed file
loadFiles

Load simulation objects according to filelist
eventDiagram

Simulation event diagram
rasterizeReduced

Convert reduced representation to full raster
changeObjEnv

Copy or move objects from one environment to another
spades

Run a spatial discrete event simulation
.first

Event priority
SpaDES-package

Categorized overview of the SpaDES package
spadesMaps

Dummy maps included with SpaDES
cir

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

Make an optimal layout of plots
.findFactors

Find factors
.objectNames

Extracts the object names
.inputObjects

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

Divergent colour palette
append_attr

Add a module to a moduleList
.unittrim

Convert grid.locator units
.makeViewports

Make viewports
.parseModule

Parse and initialize a module
agentLocation

SELES - Agent Location at initiation
.arrangeViewports

Determine optimal plotting arrangement of plot objects
move

Move
.spadesGrob-class

The .spadesGrob class
checkObject

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

Process a simulation event
checkModule

Check for the existence of a remote module
checkParams

Check use and existence of params passed to simulation.
depsGraph

Build a module dependency graph
splitRaster

Split a raster into multiple tiles.
randomPolygons

randomPolygons
transitions

SELES - Transitioning to next time step
moduleMetadata

Parse and extract module metadata
.depsLoadOrder

Determine module load order
rasterToMemory

Read raster to memory
dwrpnorm2

Vectorized wrapped normal density function
probInit

SELES - Probability of Initiation
minTimeunit

Determine the smallest timeunit in a simulation
updateList

Update elements of a named list with elements of a second named list
.makeColorMatrix

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

Determine the largest timestep unit in a simulation
newModule

Create new module from template.
downloadData

Download module data
normPath

Normalize filepath
downloadModule

Download a module from a SpaDES module GitHub repository
digest

Calculate the hashes of multiple files
gpar

Importing some grid functions
paths

Specify paths for modules, inputs, and outputs
numAgents

SELES - Number of Agents to initiate
.spadesPlottables-class

The .spadesPlottables class
packages

Get simulation package dependencies
dev

Specify where to plot
moduleCoverage

Calculate module coverage of unit tests
clearPlot

Clear plotting device
initialize,simList-method

Generate a simList object
clearStubArtifacts

Clear erroneous archivist artifacts
params

Get and set simulation parameters.
depsEdgeList

Build edge list for module dependency graph
getModuleVersion

Find the latest module version from a SpaDES module repository
loadPackages

Load packages.
newPlot

Open a new plotting window
.makeSpadesPlot

Make a .spadesPlot class object
wrap

Wrap coordinates or pixels in a torus-like fashion
.emptyMetadata

Default (empty) metadata
doEvent.checkpoint

Simulation checkpoints.
adj.raw

Fast `adjacent` function, and Just In Time compiled version
simList_-class

The simList_ class
.unparsed

Determine which modules in a list are unparsed
.assignSpaDES

Assign to the internal SpaDES environment.
checksums

Calculate checksums for a module's data files
defineParameter

Define a parameter used in a module
patchSize

Patch size
.existsSpaDES

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

Plot spatial grobs (using grid package)
.fileTableIn

Create empty fileTable for inputs and outputs
.getSpaDES

Get objects from the internal SpaDES environment
scheduleEvent

Schedule a simulation event
events

Simulation event lists
.makeList

Convert plotArgs to list of lists
.spadesEnv

The SpaDES environment
ls.str.simList

List simulation objects and their structure
nlayers,list-method

Find the number of layers in a Spatial Object
inRange

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

Extract or replace an object from the simulation environment
clickValues

Mouse interactions with Plots
.spadesPlotObjects-class

The .spadesPlotObjects class
inSeconds

Convert time units
heading

Heading between spatial points.
paddedFloatToChar

Convert numeric to character with padding
.simList-class

The simList class
.addDepends

Add simulation dependencies
spatialObjects-class

The spatialObjects class
modules

Simulation modules and dependencies
.arrangement-class

The .arrangement class
objectDiagram

Simulation object dependency diagram
inputs

Inputs and outputs
ls.simList

List simulation objects
equalExtent

Assess whether a list of extents are all equal
rndstr

Generate random strings
.simDeps-class

The .simDeps class
.depsPruneEdges

Prune edges to remove cycles in module dependencies
sortDotsFirst

Sort a any named object with dotted names first
ganttStatus

ganttStatus
checkPath

Check filepath.
.parseArgs

Parse arguments and find environments
.moduleDeps-class

The .moduleDeps class
specificNumPerPatch

specificNumPerPatch
.identifyGrobToPlot

Identify where to get the grob from
newProgressBar

Progress bar
openModules

Open all modules nested within a base directory
show,simList-method

Show an Object
setColors<-

Set colours for plotting Raster* objects.
envir

Simulation environment
times

Get and set simulation times.
.spadesPlot-class

The .spadesPlot class
Plot

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

Cache method for simList class objects
defineModule

Define a new module.
.sim2gantt

sim2gantt
gaussMap

Produce a raster of a random Gaussian process.
.updateSpadesPlot

Merge two SpaDES Plot objects
spadesClasses

Classes defined in SpaDES
layerNames

Extract the layer names of Spatial Objects
getColors

Get colours for plotting Raster* objects.
makeLines

Make SpatialLines object from two SpatialPoints objects
makeDigestible

Remove any reference to environments in a simList
dyears

SpaDES time units
initiateAgents

SELES - Initiate agents
moduleDiagram

Simulation module dependency diagram
.prepareRaster

Prepare raster for plotting
simInit

Initialize a new simulation
saveFiles

Save objects using .saveObjects in params slot of simInit
zipModule

Create a zip archive of a module subdirectory
spread

Simulate a spread process on a landscape.