get_object_info: Format object information string

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

Format object information string

Description

Format object information string

Usage

get_object_info(
  dt_object,
  component = c("id", "name", "class"),
  by_class = FALSE,
  numbered = TRUE,
  collapse = NULL,
  prefix = NULL,
  name_prefix = TRUE
)

Arguments

dt_object	A data.table::data.table() of object data
component	A character vector specifying what information to be formatted. Should be a subset of "id", "name" and "class". Defaults are all of them.
by_class	If TRUE, multiple objects in the same class will be concatenated. Default: FALSE.
numbered	If TRUE, a index number will be prepended. If rleid column exists in dt_object, its values will be used as the index numbers.
collapse	A single string used to collapse the results into a single string. Default: NULL.
prefix	A character vector used to add at the beginning of object information. Default: NULL.
name_prefix	If TRUE, Default: TRUE.

Value

A character vector of the same length as the row number of input dt_object if collapse is NULL. Otherwise a single string.

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