R Observatory: Metrics for eplusr version 0.18.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

eplusr

0.18.0Package record

A Toolkit for Using Whole Building Simulation Program 'EnergyPlus'

0packages depend

6Kdownloads / year

72.9%test coverage

13/13flavors OK

Overview

About

Maintained by Hongyuan JiaCRAN page ↗GitHub ↗Website ↗Issues ↗

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.

Changes in 0.18.0

New features

Add support for EnergyPlus v26.2.0 (#647).
IdfObject$is_valid_field() can now check whether fields are present in the current object instead of only being defined in the IDD (#391).
Add a field argument to $to_string() methods to optionally omit field name comments from generated IDF strings (#77).
Add Idf$reorder() to reorder objects within a class without changing object IDs (#66).
Idf$drop() and IdfObject$drop() can now remove field slots from extensible groups or numbered repeated field sequences and shift following values forward (#217).
Yes/No choice fields in Idf$add(), Idf$set(), Idf$load(), Idf$update(), and IdfObject$set() now accept logical TRUE and FALSE inputs as aliases for "Yes" and "No" (#257).

Show all changes in 0.18.0Hide the rest of the changes in 0.18.0

Internal refactor

Remove redundant field resets from trans_funs$f2510t2520() and trans_funs$f2520t2610() because transition loading is driven by class and index (#646).
Run tests serially by default and reserve network, transition, preprocessor, and other heavy external-program checks for an explicit integration mode, while retaining latest-version SQLite output coverage in the default suite (#637).
Use DuckDB to read EnergyPlus SQLite output files, reducing eplusr's recursive dependency chain and raising the minimum supported R version to 4.2.0 (#635).
Use cli conditions for eplusr verbose logging, package warnings, errors, and narrow user-facing console messages while preserving eplusr condition classes (#551).
Truncate large parametric verbose messages and print summarized status output for large parametric jobs (#569).

Bug fixes

Preserve original positions when parsing mixed EPW date formats, including decimal month/day strings ending in zero (#650).
Report the correct integer fields in truncation warnings (#650).
Reject unavailable or failed snapshot exports and preserve existing destination files until an export succeeds (#650).
Match weather dictionary cloneability to its parent IDD class, avoiding R6 inheritance diagnostics when reading EPW files (#650).
Keep IdfViewer triangulation compatible with decido 0.5.0 and infer detailed fenestration vertices from populated XYZ coordinate fields (#643).
Validate active extensible groups using the first-group required-field template, allowing optional fields without defaults to remain empty (#641).
Allow optional fields with default values to remain empty inside active extensible groups during validation (#640).
Reject character field values that contain IDF delimiters, preventing comma or semicolon inputs from corrupting generated IDF syntax (#67).
Skip CRAN checks that would otherwise download the latest EnergyPlus IDD during IDD relation tests.

From NEWS.md in the release

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("eplusr", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("hongyuanjia/eplusr")

Development version from hongyuanjia/eplusr. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-eplusr

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-eplusr

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-eplusr

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

Slowest check: 6.9 min · r-oldrel-windows-x86_64

Status changes

OK13 OK2026-08-20
ERROR12 OK, 1 ERROR2026-08-18
OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK13 OK2026-06-17

Show 9 earlier changesHide 9 earlier changes

ERROR12 OK, 1 ERROR2026-06-15
OK13 OK2026-05-14
ERROR12 OK, 1 ERROR2026-05-11
OK12 OK2026-04-25
NOTE12 OK, 2 NOTE2026-04-24
ERROR11 OK, 2 NOTE, 1 ERROR2026-04-23
NOTE12 OK, 2 NOTE2026-04-15
ERROR11 OK, 2 NOTE, 1 ERROR2026-04-11
NOTE12 OK, 2 NOTE2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 0.18.0

READMEYes · 656 wordsVignettes· In the repository, left out of the releaseNEWSYes · 100% structured · mentions 0.18.0Citation fileYes · cites a publicationWebsiteYes · pkgdown

Help pages: 85 (36 internal)includes a package overview page
Examples that run: 11%5 run in a plain check · 40 never run
Exported functions with examples: 51%
Documented parameters: 97%
Return-value docs: 85%
Help pages citing references: 2%

How these are measured

Downloads

6K

CRAN downloads in the past year

Rank #5,001 · ~16/day · ~499/mo

Releases R versions

Daily download trend is not available in this view yet.

77130 days

1.6K90 days

6K1 year

Compare downloads with other packages →

Also on464 r2u4 autocran

How downloads are counted

Repository

hongyuanjia/eplusr ↗Account: hongyuanjia

75Stars

15Forks

20Open issues

3Open PRs

26Releases

1,916Commits

3Commit identities

energyplusridfiddeplusr6parametric-simulationepw

1,916 commits · Last activity 2026-10-12 · 0% stars, 30d · Default branch at 0.18.0.9000, ahead of CRAN 0.18.0 (checked 2026-10-18)

Responsiveness

How these are sampled

PRs merged (all time): 97%
Median days to close, 50 most recently updated closed issues: 19
Median days to close, 50 most recently updated closed PRs: 0

Stars over time

2025-04-16 · 712026-07-07 · 75

How these are measured

PracticesBeta

14 development-tooling and community-health practices detected across 7 families in the upstream repository

Checks run against github.com/hongyuanjia/eplusr on 2026-10-18.

Continuous integration (2)

GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Governance and community (3)

Code of conductIssue templatesPR template

Docs source (4)

README.Rmdpkgdown

GitHub Pages site last deployed 2026-10-12 · The repository has a site deploy workflow

pkgdown site last built 2026-10-12

Coverage (1)

Coverage reporting (Codecov)

Show all practicesHide 3 practices

Reproducibility and dev environment (1)

Dev Container

CRAN release process (2)

cran-comments.mdrevdep/

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v3 (2026-09-26)

Dependencies

Declared dependencies

20 external dependencies (excludes base and recommended)

Installing eplusr adds 18 packages (12 with compiled code, 26 MB of source tarballs). Heaviest: stringi 11 MB, data.table 5.7 MB, duckdb 4.6 MB.

Depends (1)

R >= 4.2.0

Imports (11)

callr checkmate cli data.table duckdb jsonlite lubridate processx R6 S7 stringi

LinkingTo (0)

none

Suggests (9)

chromote hms decido png rgl testthat (>= 3.0.0)units webshot2 withr

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

People & History

People (2)

Hongyuan Jia

Adrian Chong

Author · added in 0.15.0

Releases (28)

Pick two releases to compare their code metrics.

0.18.0Latest
record
2026-10-12 · current release · diff ↗ ·
added 1 export
install_duckdb_sqlite
·
listed once in CRAN's queue
Seen in one reading of CRAN's incoming queue, at 2026-10-12 18:25 UTC, so it stayed less than the time between readings.
0.17.0
record
2026-06-20 · diff ↗ ·
added 2 exports
read_job, save_job
R
R 4.6.0 released · 2026-04-24
0.16.3
record
2025-04-22 · diff ↗
R
R 4.5.0 released · 2025-04-11
R
R 4.4.0 released · 2024-04-24
0.16.2
record
2023-08-25 · diff ↗
0.16.1
record
2023-06-19 · diff ↗
0.16.0
record
2023-05-17 · diff ↗ ·
added 1 export
as_EpwDate
R
R 4.3.0 released · 2023-04-21
0.15.3
record
2022-11-20 · diff ↗
0.15.2
record
2022-08-19 · diff ↗ ·
added 1 export
get_super_env
R
R 4.2.0 released · 2022-04-22
0.15.1
record
2022-01-21 · diff ↗
0.15.0
record
2021-11-17 · diff ↗ ·
added 16 exports
Basement, EPMacro, EnergyPlus, ExpandObjects, HVAC_Diagram, ReadVarsESO, Slab, convertESOMTR, energyplus, locate_eplus, path_eplus, path_eplus_dataset, path_eplus_example, path_eplus_processor, path_eplus_weather, uninstall_eplus
0.14.2
record
2021-05-29 · diff ↗

Show 23 earlier eventsHide 23 earlier events

R
R 4.1.0 released · 2021-05-18
0.14.1
record
2021-02-25 · diff ↗
0.14.0
record
2021-01-07 · diff ↗
0.13.0
record
2020-08-28 · diff ↗ ·
added 47 exports
IdfGeometry, IdfSchedule, IdfScheduleCompact, IdfViewer, add_idf_object, assign_idf_value_default, del_idf_object, dup_idf_object, duplicated_idf_object, expand_idf_dots_literal, expand_idf_dots_name, expand_idf_dots_object, expand_idf_dots_value, expand_idf_regex, get_idd_class, get_idd_field, get_idd_relation, get_idf_node_relation, get_idf_object, get_idf_relation, get_idf_table, get_idf_value, get_object_info, get_priv_env, get_self_env, idf_geometry, idf_viewer, init_idf_object, init_idf_value, make_idf_object_name and 17 more
R
R 4.0.0 released · 2020-04-24
0.12.0
record
2020-02-20 · diff ↗
0.11.0
record
2020-01-20 · diff ↗ ·
added 15 exports
EplusGroupJob, EplusJob, EplusSql, Epw, Idd, IddObject, Idf, IdfObject, ParametricJob, dt_to_load, group_job, mdd_to_load, rdd_to_load, transition, version_updater
0.10.4
record
2019-11-05 · diff ↗
0.10.3
record
2019-07-08 · diff ↗ ·
added 2 exports
read_mdd, read_rdd
0.10.2
record
2019-05-13 · diff ↗
0.10.1
record
2019-05-09 · diff ↗
0.10.0
record
2019-05-03 · diff ↗ ·
added 14 exports
custom_validate, empty_idf, idd_object, idf_object, is_eplus_path, is_eplus_ver, is_epw, is_idd, is_idd_ver, is_iddobject, is_idf, is_idfobject, level_checks, read_err
R
R 3.6.0 released · 2019-04-26
0.9.4
record
2018-12-05 · diff ↗ ·
added 1 export
download_weather
0.9.3
record
2018-10-11 · diff ↗
0.9.2
record
2018-09-30 · diff ↗ ·
added 1 export
eplus_sql
0.9.1
record
2018-08-29 · diff ↗
unarchivedReturned to CRAN
2018-08-27
0.9.0
record
2018-08-27 · diff ↗
archivedRemoved from CRAN
2018-08-08
policy violation Leaves 'EnergyPlus' installer file and installation in home
0.8.3
record
2018-08-08 · diff ↗
0.8.2
record
2018-07-22
R
R 3.5.0 released · 2018-04-23

Across CRAN, the median accepted release of the past year spent 23 hours in the queue, 90% under 11 days.How queue time is measured

Package metadata

First published: 2018-07-22
Total releases: 28 / 8 yrs
License: MIT + file LICENSE OSI · relicensed from GPL-3 in 0.9.4
Minimum R: ≥ 4.2.0
Download size: 1.9 MB

Cite

Cite this package

Run in R for the authors' entry:

citation("eplusr")

The package provides a citation file, so citation() returns the authors' own entry.

It points to 10.1016/j.enbuild.2021.110757.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for eplusr version 0.18.0 [Data set]. HJJB, LLC. Data release v2026-10-21. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-21, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →