eplusr_option: Get and Set eplusr options

In eplusr: A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'

Get and Set eplusr options

Description

Get and set eplusr options which affect the way in which eplusr computes and displays its results.

Usage

eplusr_option(...)

Arguments

...	Any available options to define, using name = value. All available options are shown below. If no options are given, all values of current options are returned. If a single option name, its value is returned.

Details

• validate_level: The strictness level of validation during field value modification and model error checking. Possible value: "none", "draft" and "final" or a custom validation level using custom_validate(). Default: "final". For what validation components each level contains, see level_checks().

• view_in_ip: Whether models should be presented in IP units. Default: FALSE. It is not recommended to set this option to TRUE as currently IP-units support in eplusr is not fully tested.

• save_format: The default format to use when saving Idf objects to .idf files. Possible values: "asis", "sorted", "new_top" and "new_bot". The later three have the same effect as ⁠Save Options⁠ settings "Sorted", "Original with New at Top" and "Original with New at Bottom" in IDF Editor, respectively. For "asis", the saving format will be set according to the header of IDF file. If no header found, "sorted" is used. Default: "asis".

• num_parallel: Maximum number of parallel simulations to run. Default: parallel::detectCores().

• verbose_info: Whether to show information messages. Default: TRUE.

• autocomplete: Deprecated. Whether to turn on autocompletion on class and field names. Now autocompletion is enabled all the time.

Value

If called directly, a named list of input option values. If input is a single option name, a length-one vector whose type is determined by that option. If input is new option values, a named list of newly set option values.

Author(s)

Hongyuan Jia

Examples

# list all current options
eplusr_option() # a named list

# get a specific option value
eplusr_option("verbose_info")

# set options
eplusr_option(verbose_info = TRUE, view_in_ip = FALSE)

eplusr documentation built on Aug. 25, 2023, 5:18 p.m.