packages: Get module or simulation package dependencies

packagesR Documentation

Get module or simulation package dependencies

Description

Get module or simulation package dependencies

Usage

packages(sim, modules, paths, filenames, envir, clean = FALSE, ...)

## S4 method for signature 'ANY'
packages(sim, modules, paths, filenames, envir, clean = FALSE, ...)

Arguments

sim

A simList object.

modules

Character vector, specifying the name or vector of names of module(s)

paths

Character vector, specifying the name or vector of names of paths(s) for those modules. If path not specified, it will be taken from getOption("spades.modulePath"), which is set with setPaths())

filenames

Character vector specifying filenames of modules (i.e. combined path & module. If this is specified, then modules and path are ignored.

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.

clean

Optional logical. If TRUE, it will scrub any references to GitHub repositories, e.g., "PredictiveEcology/reproducible" will be returned as "reproducible".

...

All simInit parameters.

Value

A sorted character vector of package names.

Author(s)

Alex Chubaty & Eliot McIntire

See Also

Other functions to access elements of a 'simList' object: .addDepends(), checkpointFile(), envir(), events(), globals(), inputs(), modules(), objs(), params(), paths(), progressInterval(), times()


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