Parse and extract a module's version
moduleVersion(module, path, sim, envir = NULL)
# S4 method for character,character,missing
moduleVersion(module, path, envir)
# S4 method for character,missing,missing
moduleVersion(module, envir)
# S4 method for character,missing,simList
moduleVersion(module, sim, envir)
Character string. Your module's name.
Character string specifying the file path to modules directory.
Default is to use the spades.modulePath
option.
A simList
simulation object, generally produced by simInit
.
Optional environment in which to store parsed code. This may be
useful if the same file is being parsed multiple times. This
function will check in that environment for the parsed file before
parsing again. If the envir
is transient, then this will have no effect.
numeric_version
indicating the module's version.
# using filepath
path <- getSampleModules(tempdir())
moduleVersion("caribouMovement", path)
#> [1] ‘1.6.1’
# using simList
options("spades.useRequire" = FALSE)
if (require("SpaDES.tools", quietly = TRUE)) {
mySim <- simInit(
times = list(start = 2000.0, end = 2002.0, timeunit = "year"),
params = list(
.globals = list(stackName = "landscape", burnStats = "nPixelsBurned")
),
modules = list("caribouMovement"),
paths = list(modulePath = path)
)
moduleVersion("caribouMovement", sim = mySim)
}
#> Setting:
#> options(
#> spades.modulePath = '/tmp/Rtmpd0rH1m/sampleModules'
#> )
#> Paths set to:
#> options(
#> rasterTmpDir = '/tmp/Rtmpd0rH1m/SpaDES/scratch/raster'
#> reproducible.cachePath = '/tmp/Rtmpd0rH1m/reproducible/cache'
#> spades.inputPath = '/tmp/Rtmpd0rH1m/SpaDES/inputs'
#> spades.outputPath = '/tmp/Rtmpd0rH1m/SpaDES/outputs'
#> spades.modulePath = '/tmp/Rtmpd0rH1m/sampleModules'
#> spades.scratchPath = '/tmp/Rtmpd0rH1m/SpaDES/scratch'
#> )
#> terra::terraOptions(tempdir = '/tmp/Rtmpd0rH1m/SpaDES/scratch/terra'
#> Jun07 03:21:57 simInit Using setDTthreads(1). To change: 'options(spades.DTthreads = X)'.
#> Jun07 03:21:57 simInit caribouMovement: module code: landscape, caribou are declared in metadata inputObjects, but no default(s) are provided in .inputObjects
#> Jun07 03:21:57 simInit caribouMovement: module code: landscape is declared in metadata inputObjects, but is not used in the module
#> Jun07 03:21:57 simInit caribouMovement: inputObjects: Par$stackName is used from sim inside Init, but is not declared in metadata inputObjects
#> Jun07 03:21:57 simInit caribouMovement: inputObjects: Par$stackName is used from sim inside Move, but is not declared in metadata inputObjects
#> Jun07 03:21:57 simInit The following .globals were used:
#> Jun07 03:21:57 simInit Key: <global, module>
#> Jun07 03:21:57 simInit module global
#> Jun07 03:21:57 simInit <char> <char>
#> Jun07 03:21:57 simInit 1: caribouMovement stackName
#> Jun07 03:21:57 simInit Global parameter(s) not used in any module: burnStats.
#> Elpsed time for simInit: 0.1437035 secs
#> [1] ‘1.6.1’