moduleVersion: Parse and extract a module's version

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Parse and extract a module's version

Description

Parse and extract a module's version

Usage

moduleVersion(module, path, sim, envir = NULL)

## S4 method for signature 'character,character,missing'
moduleVersion(module, path, envir)

## S4 method for signature 'character,missing,missing'
moduleVersion(module, envir)

## S4 method for signature '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 environment 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.

Author(s)

Alex Chubaty

See Also

moduleMetadata()

Examples

# using filepath
path <- getSampleModules(tempdir())
moduleVersion("caribouMovement", path)

# 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)
}

SpaDES.core documentation built on June 22, 2024, 10:32 a.m.