getSettingsTable: Get all domains names from the default settings file

In dof1985/cwatm4r: What the Package Does (One Line, Title Case)

Get all domains names from the default settings file

Description

This function provides a table with all variables and values for a given domain of the CWatM settings file.

Usage

getSettingsTable(settingsfile = NULL, domain)

Arguments

settingsfile	A character vector with a path to an MS Excel settings file or to a settings.ini file. Defaults to NULL
domain	A character vector with a settings file domain name

Details

The function extracts data from a user-defined settings file. In case a user does not define a settings file (settingsfile = NULL), the results show a default settings file.

Value

A data.frame with all variables, values, and comments for a given domain (see Details).

Examples

getSettingsTable(settingsfile = NULL, domain = "FILE_PATHS")
dontrun {
getSettingsTable(settingsfile = "C:/IIASA/cwatm/cwatm_settings/cwatm_settings.xlsx", domain = "OPTIONS")
getSettingsTable(settingsfile = "C:/IIASA/cwatm/cwatm_settings/cwatm_settings_sorekBasin.ini", domain = "OPTIONS")
}

dof1985/cwatm4r documentation built on Nov. 8, 2022, 7:30 p.m.