set_idf_object: Modifying existing objects

View source: R/impl-idf.R

set_idf_objectR Documentation

Modifying existing objects

Description

Modifying existing objects

Usage

set_idf_object(
  idd_env,
  idf_env,
  dt_object,
  dt_value,
  empty = FALSE,
  level = eplusr_option("validate_level"),
  replace = 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.

dt_object

A data.table::data.table() that contains object data.

dt_value

A data.table::data.table() that contains value data.

empty

If TRUE, trailing empty fields are kept. Default: FALSE.

level

Validate level. Default: eplusr_option("validate_level").

Value

The modified Idf data in a named list of 5 elements, i.e. object, value, reference, changed and updated. First 3 elements are data.table::data.table()s containing the actual updated Idf data while changed and updated are integer vectors containing IDs of objects that have been directly changed and indirectly updated due to references, respectively.


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