Skip to content

Module Utilities

Inspect, create, and maintain modular GAMS model structure

getModules()
getModules
is.modularGAMS()
is.modularGAMS
module.skeleton()
Create a Module skeleton
singleGAMSfile()
Merge GAMS code into single file
convert.modularGAMS()
convert.modularGAMS
update_modules_embedding()
Update Modules Embedding in GAMS code
updateInterfaceMapping()
updateInterfaceMapping
writeSets()
writeSets

Code Checks

Validate and check the consistency of modular GAMS model code

codeCheck()
codeCheck
checkAppearance()
checkAppearance
checkDescription()
checkDescription
checkNoTabs()
checkNoTabs
checkSwitchAppearance()
checkSwitchAppearance
settingsCheck()
settingsCheck

Code Parsing & Extraction

Parse and extract information from GAMS source code

GAMScodeFilter()
GAMScodeFilter
codeExtract()
codeExtract
readDeclarations()
readDeclarations
readParameterValues()
readParameterValues
readSetglobals()
readSetglobals
readSettings()
readSettings
read_yaml_header()
read_yaml_header

Configuration

Read, write, and validate model configuration

loadConfig()
Load Config
saveConfig()
Save Config
readDefaultConfig()
readDefaultConfig
check_config()
Check config
setScenario()
setScenario

Data Management

Download, distribute, and manage model input data

download_distribute()
Download and unpack compressed data from repositories
download_unpack()
Download and unpack compressed data from repositories
publish_data()
Publish data in a repository
copy_input()
copy_input
delete_olddata()
delete_olddata
getfiledestinations()
getfiledestinations
tardir()
Create tgz archive from directory
fulldataOutput()
fulldataOutput
update_fulldataOutput()
update_fulldataOutput

Visualization

Visualize module interfaces and model structure

interfaceplot()
interfaceplot
modules_interfaceplot()
modules_interfaceplot

Model Locking

Manage concurrent access to a model folder

Utilities

General-purpose helper functions

chooseFromList()
chooseFromList
selectScript()
selectScript
getLine()
getLine
get_info()
get_info
path()
path
readFileOrVector()
readFileOrVector
replace_in_file()
Replace in File
model_dependencies()
Function to detect R package dependencies
gms gms-package
gms: 'GAMS' Modularization Support Package