expand_idf_dots_literal {eplusr}R Documentation

Parse object values given in literal character vectors or data.frames

Description

Parse object values given in literal character vectors or data.frames

Usage

expand_idf_dots_literal(idd_env, idf_env, ..., .default = TRUE, .exact = FALSE)

Arguments

idd_env

An environment or list contains IDD tables including class, field, and reference.

idf_env

An environment or list contains IDF tables including object, value, and reference.

...

Character vectors or data.frames.

.default

If TRUE, all empty fields will be filled with default values if possible. Default: TRUE.

.exact

If TRUE, all inputs should match existing objects in the Idf. In this case, id column is require for data.frame input. Default: FALSE.

Details

For object definitions in character vector format, they follow the same rules as a normal IDF file:

Each character vector can contain:

You can also provide an option header to indicate if input objects are presented in IP units, using ⁠!-Option ViewInIPunits⁠. If this header does not exist, then all values are treated as in SI units.

For object definitions in data.frame format, a valid definition requires at least three columns described below. Note that column order does not matter.

Value

A named list of 2 element object and value which is a data.table::data.table() with object data and value data respectively.

Note

Objects from character vectors will always be at the top of each table.


[Package eplusr version 0.16.2 Index]