A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'

---

Documentation for package ‘eplusr’ version 0.16.2

• DESCRIPTION file.
• Package NEWS.

Help Pages

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