Package: eplusr 0.16.2.9007

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

A rich toolkit of using the whole building simulation program 'EnergyPlus'(<https://energyplus.net>), which enables programmatic navigation, modification of 'EnergyPlus' models and makes it less painful to do parametric simulations and analysis.

Authors:Hongyuan Jia [aut, cre], Adrian Chong [aut]

eplusr_0.16.2.9007.tar.gz
eplusr_0.16.2.9007.zip(r-4.5)eplusr_0.16.2.9007.zip(r-4.4)eplusr_0.16.2.9007.zip(r-4.3)
eplusr_0.16.2.9007.tgz(r-4.4-any)eplusr_0.16.2.9007.tgz(r-4.3-any)
eplusr_0.16.2.9007.tar.gz(r-4.5-noble)eplusr_0.16.2.9007.tar.gz(r-4.4-noble)
eplusr_0.16.2.9007.tgz(r-4.4-emscripten)eplusr_0.16.2.9007.tgz(r-4.3-emscripten)
eplusr.pdf |eplusr.html✨
eplusr/json (API)
NEWS

# Install 'eplusr' in R:
install.packages('eplusr', repos = c('https://hongyuanjia.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/hongyuanjia/eplusr/issues

On CRAN:

energy-simulationenergyplusenergyplus-modelseplusepwiddidfparametric-simulationr6simulation

116 exports 67 stars 3.87 score 29 dependencies 4 dependents 91 scripts 667 downloads

Last updated 2 months agofrom:cd49ffc042. Checks:OK: 1 NOTE: 6. Indexed: yes.

TargetResultDate
Doc / VignettesOKAug 26 2024
R-4.5-winNOTEAug 26 2024
R-4.5-linuxNOTEAug 26 2024
R-4.4-winNOTEAug 26 2024
R-4.4-macNOTEAug 26 2024
R-4.3-winNOTEAug 26 2024
R-4.3-macNOTEAug 26 2024

Exports:add_idf_objectas_EpwDateassign_idf_value_defaultavail_eplusavail_iddBasementclean_wdconvertESOMTRcustom_validatedel_idf_objectdownload_eplusdownload_idddownload_weatherdt_to_loaddup_idf_objectduplicated_idf_objectempty_idfenergyplusEnergyPluseplus_configeplus_jobeplus_sqlEplusGroupJobEplusJobeplusr_optionEplusSqlEPMacroEpwexpand_idf_dots_literalexpand_idf_dots_nameexpand_idf_dots_objectexpand_idf_dots_valueexpand_idf_regexExpandObjectsget_idd_classget_idd_fieldget_idd_relationget_idf_node_relationget_idf_objectget_idf_relationget_idf_tableget_idf_valueget_object_infoget_priv_envget_self_envget_super_envgroup_jobHVAC_DiagramIddidd_objectIddObjectIdfidf_geometryidf_objectidf_viewerIdfGeometryIdfObjectIdfScheduleIdfScheduleCompactIdfViewerinit_idf_objectinit_idf_valueinstall_eplusis_avail_eplusis_avail_iddis_eplus_pathis_eplus_veris_epwis_iddis_idd_veris_iddobjectis_idfis_idfobjectlevel_checkslocate_eplusmake_idf_object_namemdd_to_loadparam_jobParametricJobparse_dots_valuepath_epluspath_eplus_datasetpath_eplus_examplepath_eplus_processorpath_eplus_weatherpurge_idf_objectrdd_to_loadread_epwread_errread_idfread_idfeditor_copyread_mddread_rddReadVarsESOreloadremove_duplicated_objectsremove_empty_fieldsrename_idf_objectrun_idfrun_multischedule_compactset_idf_objectSlabstandardize_idf_valuetransitionuninstall_eplusunique_idf_objectuse_eplususe_iddvalidate_objectsversion_updaterwith_optionwith_silentwith_speedwith_verbosewithout_checking

Dependencies:backportsbitbit64blobcachemcallrcheckmateclicpp11data.tableDBIfastmapgenericsgluelifecyclelubridatememoisepkgconfigplogrprocessxpsR6RcpprlangRSQLitestringitimechangeunitsvctrs

Readme and manuals

Help Manual

Help pageTopics
eplusr: A Toolkit for Using EnergyPlus in Replusr-package eplusr
Coerce an IddObject into a Character Vectoras.character.IddObject
Coerce an Idf object into a Character Vectoras.character.Idf
Coerce an IdfObject into a Character Vectoras.character.IdfObject
Clean working directory of a previous EnergyPlus simulationclean_wd
Customize validation componentscustom_validate
Download EnergyPlus Weather File (EPW) and Design Day File (DDY)download_weather
Format Long Table to Standard Input for 'Idf$load()' Methoddt_to_load
Create an Empty Idfempty_idf
Read an Energy SQLite Output Fileeplus_sql
Create and Run Parametric Analysis, and Collect ResultsEplusGroupJob group_job
Run EnergyPlus Simulation and Collect OutputsEplusJob eplus_job
Get and Set eplusr optionseplusr_option
Retrieve Simulation Outputs Using EnergyPlus SQLite Output FileEplusSql
Read, and modify an EnergyPlus Weather File (EPW)Epw
Format an Iddformat.Idd
Format an IddObjectformat.IddObject
Format an Idf Objectformat.Idf
Format an IdfObjectformat.IdfObject
Parse, Query and Modify EnergyPlus Input Data Dictionary (IDD)Idd
Create an 'IddObject' object.idd_object
EnergyPlus IDD objectIddObject
Read, Modify, and Run an EnergyPlus ModelIdf
Create an 'IdfObject' object.idf_object
Modify and Visualize an EnergyPlus Model GeometryIdfGeometry idf_geometry
Create and Modify an EnergyPlus ObjectIdfObject
Create an 'IdfScheduleCompact' object.IdfSchedule IdfScheduleCompact schedule_compact
Visualize an EnergyPlus Model Geometry and Simulation ResultsIdfViewer idf_viewer
Download and Install EnergyPlusdownload_eplus install_eplus uninstall_eplus
Check for Idd, Idf and Epw objectsis_eplus_path is_eplus_ver is_epw is_idd is_iddobject is_idd_ver is_idf is_idfobject
Show components of validation strictness levellevel_checks
Create and Run Parametric Analysis, and Collect ResultsParametricJob param_job
Get file path from EnergyPlus installation directorypath_eplus path_eplus_dataset path_eplus_example path_eplus_processor path_eplus_weather
Print EnergyPlus Error Fileprint.ErrFile
Print EnergyPlus Transition Error Fileprint.TransitionErrFile
Format RddFile Object to Standard Input for 'Idf$load()' Methodmdd_to_load rdd_to_load
Read and Parse EnergyPlus Weather File (EPW)read_epw
Read an EnergyPlus Simulation Error Fileread_err
Read an EnergyPlus Input Data File (IDF)read_idf
Read an EnergyPlus Report Data Dictionary Fileread_mdd read_rdd
Reload Idf datareload
Run simulations of EnergyPlus models.run_idf run_multi
Perform version transition of EnergyPlus modeltransition
Configure which version of EnergyPlus to useavail_eplus eplus_config is_avail_eplus locate_eplus use_eplus
Use a specific EnergyPlus Input Data Dictionary (IDD) fileavail_idd download_idd is_avail_idd use_idd
Run IDFVersionUpdater to Update Model Versionsversion_updater
Evaluate an expression with temporary eplusr optionswithout_checking with_option with_silent with_verbose