Function reference • eplusr

IDD Use a specific EnergyPlus Input Data Dictionary (IDD)
`Idd`	Parse, Query and Modify EnergyPlus Input Data Dictionary (IDD)
`IddObject`	EnergyPlus IDD object
`idd_object()`	Create an `IddObject` object.
`use_idd()` `download_idd()` `avail_idd()` `is_avail_idd()`	Use a specific EnergyPlus Input Data Dictionary (IDD) file
`as.character(<IddObject>)`	Coerce an IddObject into a Character Vector
`format(<Idd>)`	Format an Idd
`format(<IddObject>)`	Format an IddObject
IDF Read, modify and run an EnergyPlus Input Data File (IDF)
`Idf`	Read, Modify, and Run an EnergyPlus Model
`IdfObject`	Create and Modify an EnergyPlus Object
`idf_object()`	Create an `IdfObject` object.
`read_idf()`	Read an EnergyPlus Input Data File (IDF)
`empty_idf()`	Create an Empty Idf
`transition()`	Perform version transition of EnergyPlus model
`version_updater()`	Run IDFVersionUpdater to Update Model Versions
`as.character(<Idf>)`	Coerce an Idf object into a Character Vector
`as.character(<IdfObject>)`	Coerce an IdfObject into a Character Vector
`format(<Idf>)`	Format an Idf Object
`format(<IdfObject>)`	Format an IdfObject
IDF schedules Class for IDF `Schedule:Compact` objects
`schedule_compact()`	Create an `IdfScheduleCompact` object.
IDF geometry Classes for IDF geometry
`idf_geometry()`	Modify and Visualize an EnergyPlus Model Geometry
`idf_viewer()`	Visualize an EnergyPlus Model Geometry and Simulation Results
EPW Download, read and modify an EnergyPlus Weather (EPW)
`Epw`	Read, and modify an EnergyPlus Weather File (EPW)
`read_epw()`	Read and Parse EnergyPlus Weather File (EPW)
`download_weather()`	Download EnergyPlus Weather File (EPW) and Design Day File (DDY)
Configure EnergyPlus
`install_eplus()` `uninstall_eplus()` `download_eplus()`	Download and Install EnergyPlus
`use_eplus()` `eplus_config()` `avail_eplus()` `is_avail_eplus()` `locate_eplus()`	Configure which version of EnergyPlus to use
`path_eplus()` `path_eplus_processor()` `path_eplus_example()` `path_eplus_weather()` `path_eplus_dataset()`	Get file path from EnergyPlus installation directory
Job Run EnergyPlus and collect outputs
`EplusSql`	Retrieve Simulation Outputs Using EnergyPlus SQLite Output File
`eplus_job()`	Run EnergyPlus Simulation and Collect Outputs
`group_job()`	Create and Run Parametric Analysis, and Collect Results
`param_job()`	Create and Run Parametric Analysis, and Collect Results
`eplus_sql()`	Read an Energy SQLite Output File
`run_idf()` `run_multi()`	Run simulations of EnergyPlus models.
`clean_wd()`	Clean working directory of a previous EnergyPlus simulation
`read_err()`	Read an EnergyPlus Simulation Error File
`read_rdd()` `read_mdd()`	Read an EnergyPlus Report Data Dictionary File
`print(<ErrFile>)`	Print EnergyPlus Error File
Data Helpers Help to create and format IDF data
`dt_to_load()`	Format Long Table to Standard Input for `Idf$load()` Method
`rdd_to_load()` `mdd_to_load()`	Format RddFile Object to Standard Input for `Idf$load()` Method
`reload()`	Reload Idf data
Assertion Check Types
`is_eplus_ver()` `is_idd_ver()` `is_eplus_path()` `is_idd()` `is_idf()` `is_iddobject()` `is_idfobject()` `is_epw()`	Check for Idd, Idf and Epw objects
eplusr Options
`eplusr` `eplusr-package`	eplusr: A Toolkit for Using EnergyPlus in R
`eplusr_option()`	Get and Set eplusr options
`custom_validate()`	Customize validation components
`level_checks()`	Show components of validation strictness level
`with_option()` `with_silent()` `with_verbose()` `without_checking()`	Evaluate an expression with temporary eplusr options

Reference

IDD

IDF

IDF schedules

IDF geometry

EPW

Configure EnergyPlus

Job

Data Helpers

Assertion

eplusr Options