Function reference • EnvironmentModules

Common Functions

High-level functions for interacting with modules that you will use most of the time

module_avail(): Lists all modules available to be loaded

module_list(): Lists all modules that are currently loaded

module_load(): Loads one or more environment modules

module_purge(): Unloads all modules that are currently loaded

module_swap(): Unloads one module, and loads a second module.

module_unload(): Unloads one or more environment modules

With Functions

withr-style functions that run R code in a certain module environment

with_extra_modules(): Run some R code using an additional set of modules

with_module_install(): Bake environment modules into an R package

with_only_modules(): Run some R code using a minimal set of modules

Autocomplete

Machinery that powers the “magic autocomplete”

`$`(<dollar_function>): Calls a function using the name used after the dollar sign

.DollarNames(<module_load>): Get autocompletions for module_load()

.DollarNames(<module_unload>): Get autocompletions for module_unload()

Advanced Functions

Powerful, but more complex functions you are less likely to need

check_version(): Ensures Environment Modules is above a certain version

get_module_code(): Returns the R code that would execute a given module command

get_module_output(): Evaluates a module command, and returns the text output.

get_modulescmd_binary(): Gets the file path to the modulescmd executable

get_version(): Get the current Environment Modules version

run_modulecmd(): Runs modulecmd with some arguments