init_idf_value: Initialize value data
In eplusr: A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'

init_idf_value

R Documentation

Initialize value data

Description

Initialize value data

Usage

init_idf_value(
  idd_env,
  idf_env,
  class,
  field = NULL,
  property = NULL,
  underscore = FALSE,
  complete = FALSE,
  all = FALSE,
  default = TRUE,
  id = TRUE
)

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.
`class`	An integer vector of valid class indexes or a character vector of valid class names. Default: `NULL`.
`field`	An integer vector of valid field indexes or a character vector of valid field names (can be in in underscore style). `class` and `field` should have the same length.
`property`	A character vector of column names in field table to return.
`underscore`	If `TRUE`, input class name will be converted into underscore style name first and column `class_name_us` will be used for matching. Default: `FALSE`.
`complete`	If `TRUE`, at least fields till the current whole extensible group will be returned. A new column named "matched_rleid" will be created (when `property` is NULL) indicating if given field has been matched or not. Default: `FALSE`.
`all`	If `TRUE`, all available fields defined in IDD for the class that objects belong to will be returned. Default: `FALSE`.
`default`	If `TRUE`, column `value_chr` and `value_num` will be filled with default values. Default: `TRUE`.
`id`	If `TRUE`, new value id will be added in column `value_id` based on current existing value ids found in `idf_env`. Default: `TRUE`.