format.Idf: Format an Idf Object

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

Format an Idf Object

Description

Format an Idf object.

Usage

## S3 method for class 'Idf'
format(
  x,
  comment = TRUE,
  header = TRUE,
  format = eplusr_option("save_format"),
  leading = 4L,
  sep_at = 29L,
  ...
)

Arguments

x	An Idf object.
comment	If FALSE, all comments will not be included. Default: TRUE.
header	If FALSE, the header will not be included. Default: TRUE.
format	Specific format used when formatting. For details, please see ⁠$save()⁠. Default: eplusr_option("save_format")
leading	Leading spaces added to each field. Default: 4L.
sep_at	The character width to separate value string and field string. Default: 29L which is the same as IDF Editor.
...	Further arguments passed to or from other methods.

Value

A single length string.

Author(s)

Hongyuan Jia

Examples

## Not run: 
idf_path <- system.file("extdata/1ZoneUncontrolled.idf", package = "eplusr")
cat(format(read_idf(idf_path, use_idd(8.8, "auto")), leading = 0))

## End(Not run)

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