Man pages for PredictiveEcology/SpaDES.core
Core Utilities for Developing and Running Spatially Explicit Discrete Event Simulation Models

addChangedAttr'.addChangedAttr' for simList class objects
addDependsAdd simulation dependencies
addTagsToOutputaddTagsToOutput for simList class objects
all.equal.simListAll equal method for simLists
append_attrAdd a module to a 'moduleList'
cacheMessagecacheMessage for simList class objects
checkCacheRepocheckCacheRepo for simList class objects
checkModuleCheck for the existence of a remote module
checkModuleLocalCheck for the existence of a module locally
checkObjectCheck for existence of object(s) referenced by a 'objects'...
checkParamsCheck use and existence of params passed to simulation.
checkpointSimulation checkpoints.
checksumsCalculate checksum for a module's data files
classFilterFilter objects by class
CopyCopy for simList class objects
copyModuleCreate a copy of an existing module
coreModulesNamed list of core 'SpaDES' modules
createsOutputDefine an output object of a module
defineModuleDefine a new module.
defineParameterDefine a parameter used in a module
depsEdgeListBuild edge list for module dependency graph
depsGraphBuild a module dependency graph
depsLoadOrderDetermine module load order
depsPruneEdgesPrune edges to remove cycles in module dependencies
doEventProcess a simulation event
downloadDataDownload module data
downloadModuleDownload a module from a SpaDES module GitHub repository
emptyEventListBlank (template) event list
emptyMetadataDefault (empty) metadata
eventDiagramSimulation event diagram
expectsInputDefine an input object that the module expects.
experimentRun an experiment using 'spades'
extractURLExtract a url from module metadata
fileEditOpen a file for editing
fileNameExtract filename (without extension) of a file
fileTableCreate empty fileTable for inputs and outputs
fillInputRowsAn internal function for coercing a data.frame to inputs()
fillOutputRowsAn internal function for coercing a data.frame to outputs()
findElementsFind all references to sim$
findModuleNameIdentify module names up to a given recursive level
findObjectsFind objects if passed as character strings
findSimListFind simList in a nested list
getModuleInputObjectsExtract the user-defined '.inputObjects' function from a...
getModuleVersionFind the latest module version from a SpaDES module...
globalsGet and set simulation globals.
identifyChildModulesIdentify Child Modules from a recursive list
initialize-methodGenerate a 'simList' object
inputObjectsDFCreate an empty 'data.frame' object for use with...
isNamespacedCheck is module uses module namespacing
keepAttrsAttach missing attributes from x to y
loadFilesFile extensions map
loadPackagesLoad packages.
makeMemoiseableMake simList correctly work with memoise
maxTimeunitDetermine the largest timestep unit in a simulation
minTimeunitDetermine the smallest timeunit in a simulation
modifySearchPathModify package order in search path
moduleCoverageCalculate module coverage of unit tests
moduleDefaultsDefaults values used in defineModule
moduleDeps-classThe '.moduleDeps' class
moduleDiagramSimulation module dependency diagram
moduleGraphBuild a module dependency graph
moduleMetadataParse and extract module metadata
moduleVersionParse and extract a module's version
namespacingNamespacing within 'SpaDES'
newModuleCreate new module from template
newModuleCodeCreate new module code file
newModuleDocumentationCreate new module documentation
newModuleTestsCreate template testing structures for new modules
objectDiagramSimulation object dependency diagram
objectsExtract or replace an object from the simulation environment
objSizeInclEnvirosobjSizeInclEnviros for simList class objects
objSize.simListObject size for simLists
openModulesOpen all modules nested within a base directory
packagesGet module or simulation package dependencies
paddedFloatToCharConvert numeric to character with padding
paramsGet and set simulation parameters.
parseElems.parseElems for simList class objects
parseMessagePrepend module name to a message
parseModuleParse and initialize a module
pkgEnvThe 'SpaDES.core' package environment
PlotPlot method for 'simList' objects
POMUse Pattern Oriented Modeling to fit unknown parameters
preDigestByClassPre-digesting method for 'simList'
prepareOutput'.prepareOutput' for simList
priorityEvent priority
progressGet and set simulation progress bar details
progressBarProgress bar
quickCheckThe 'SpaDES.core' variable to switch between quick and robust...
rasterToMemoryRead raster to memory
remoteFileSizeDetermine the size of a remotely hosted file
rndstrGenerate random strings
robustDigest'.robustDigest' for 'simList' class objects
runCodeChecksRuns a series of code checks during simInit
runModuleInputsObjectsRun module's '.inputObjects'
saveFilesSave objects using '.saveObjects' in 'params' slot of...
scheduleEventSchedule a simulation event
setPathsGet and set default working directories
show-methodShow an Object
simDeps-classThe '.simDeps' class
simInitInitialize a new simulation
simInitAndCall 'simInit' and 'spades' or 'experiment' together
simList-accessors-envirSimulation environment
simList-accessors-eventsSimulation event lists
simList-accessors-inoutInputs and outputs
simList-accessors-metadataMetadata accessors
simList-accessors-modulesSimulation modules and dependencies
simList-accessors-pathsSpecify paths for modules, inputs, and outputs
simList-accessors-timesTime usage in 'SpaDES'
simList_-classThe 'simList_' class
simList-classThe 'simList' class
spadesRun a spatial discrete event simulation
spades-classesClasses defined in SpaDES
SpaDES.core-packageCategorized overview of the 'SpaDES.core' package
spadesOptionsA slightly modified version of getOption
spadesTimeSpaDES time units
suppliedElsewhereAssess whether an object has or will be supplied from...
tagsByClasstagsByClass for simList class objects
timeConversionConvert time units
tryCatchtryCatch that keeps warnings, errors and value (result)
unparsedDetermine which modules in a list are unparsed
updateListUpdate elements of a named list with elements of a second...
verbChose verb conjugation for "to be"
zipModuleCreate a zip archive of a module subdirectory
PredictiveEcology/SpaDES.core documentation built on Nov. 20, 2018, 6:20 p.m.