make_idf_object_name: Initialize object data
In eplusr: A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'

make_idf_object_name

R Documentation

Initialize object data

Description

Initialize object data

Usage

make_idf_object_name(
  idd_env,
  idf_env,
  dt_object,
  use_old = TRUE,
  prefix_col = NULL,
  prefix_sep = " ",
  keep_na = TRUE,
  include_ori = 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()` containing object data.
`use_old`	If `TRUE`, new object names are based on the original object names in column `object_name`. If `FALSE`, new object names are created based on the class name it belongs to. Default: `TRUE`.
`prefix_col`	An character vector of column names in input `dt_object` whose values will be combined together as the prefix of the new object names. Default: `NULL`.
`prefix_sep`	A single string specifying the separation character among prefix columns. Default: `NULL`.
`keep_na`	If `TRUE`, new object names will be `NA` if the original object names in column `object_name` are `NA`s. Default: `TRUE`.
`include_ori`	If `TRUE`, make sure new object names are not the same as the original object names in the `object_name` column. Default: `FALSE`.