Parse and extract a module's version

Source: R/moduleMetadata.R

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)

Arguments

module

Character string. Your module's name.

path

Character string specifying the file path to modules directory. Default is to use the spades.modulePath option.

sim

A simList simulation object, generally produced by simInit.

envir

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 envir for the parsed file before parsing again. If the envir is transient, then this will have no effect.

Value

numeric_version indicating the module's version.

See also

moduleMetadata()

Author

Alex Chubaty

Examples

# using filepath
path <- system.file("sampleModules", package = "SpaDES.core")
moduleVersion("caribouMovement", path)
#> [1] ‘1.6.0’

# 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 = '/home/runner/work/_temp/Library/SpaDES.core/sampleModules'
#>   )
#> Paths set to:
#>   options(
#>     rasterTmpDir = '/tmp/RtmppEYNhs/SpaDES/scratch/raster'
#>     reproducible.cachePath = '/tmp/RtmppEYNhs/reproducible/cache'
#>     spades.inputPath = '/tmp/RtmppEYNhs/SpaDES/inputs'
#>     spades.outputPath = '/tmp/RtmppEYNhs/SpaDES/outputs'
#>     spades.modulePath = '/home/runner/work/_temp/Library/SpaDES.core/sampleModules'
#>     spades.scratchPath = '/tmp/RtmppEYNhs/SpaDES/scratch'
#>   )
#>   terra::terraOptions(tempdir = '/tmp/RtmppEYNhs/SpaDES/scratch/terra'
#> Using setDTthreads(1). To change: 'options(spades.DTthreads = X)'.
#> caribouMovement: module code: landscape, caribou are declared in metadata inputObjects, but no default(s) are provided in .inputObjects
#> caribouMovement: inputObjects: habitatQuality is used from sim inside Move, but is not declared in metadata inputObjects
#> The following .globals were used:
#>             module    global
#> 1: caribouMovement stackName
#> Jan12 22:40:02 simInit:       Global parameter(s) not used in any module: burnStats.
#> [1] ‘1.6.0’