Implements forecasting methods for individual electricity load curves, including Kernel Wavelet Functional (KWF), clustered KWF, Generalized Additive Models (GAM), Multivariate Adaptive Regression Splines (MARS), and Long Short-Term Memory (LSTM) models. Provides normalized dataset adapters for iFlex, StoreNet, Smart-Grid Smart-City, Low Carbon London, and REFIT; download and read support for IDEAL and GX; explicit Python backend selection for TensorFlow-based LSTM fits; helpers for daily segmentation and rolling-origin benchmarking; and compact shipped example panels and benchmark-result datasets.

https://doi.org/10.32614/CRAN.package.elcf4R
Implements Kernel Wavelet Functional (KWF), clustered KWF, Generalized Additive Models (GAM), Multivariate Adaptive Regression Splines (MARS) and RNN LSTM models to forecast individual electricity load curves, following the methodology described in Fahs (2023) and related articles and posters. Includes normalized dataset adapters for iFlex, StoreNet, Smart-Grid Smart-City, Low Carbon London and REFIT, scaffolded download/read support for IDEAL and GX, compact shipped example panels, and saved benchmark artifacts.
This site was created by F. Bertrand and the examples reproduced on it were created by F. Bertrand, F. Fahs and M. Maumy-Bertrand.
You can install the latest version of the elcf4R package from github with:
devtools::install_github("fbertran/elcf4R")
The exported forecasting methods currently covered by the package are:
elcf4r_fit_gam()elcf4r_fit_mars()elcf4r_fit_kwf()elcf4r_fit_kwf_clustered()elcf4r_fit_lstm()For the LSTM path, Python selection is explicit and user-driven:
elcf4r_use_tensorflow_env()reticulate::use_virtualenv() / reticulate::use_python() directlyThe current dataset adapters and shipped benchmark artifacts cover:
H6_W)SGSC) compact example panelThe current download helpers are:
elcf4r_download_elmas()elcf4r_download_storenet()elcf4r_download_sgsc()elcf4r_download_ideal()elcf4r_download_gx()Scaffolded, unshipped dataset adapters:
IDEAL: elcf4r_download_ideal() and elcf4r_read_ideal() provide a
first-pass aggregate-electricity scaffold built around the hourly summaries in
auxiliarydata.zip. The current Edinburgh DataShare record states CC BY 4.0. No IDEAL-derived package dataset is shipped in this release.GX: elcf4r_download_gx() and elcf4r_read_gx() provide a secondary
transformer/community-level scaffold from the official figshare dataset
record. GX is not treated as part of the package's core individual-household
benchmark set, and no GX-derived package dataset is shipped in this release.
Licence terms should be rechecked against the official dataset record before
any redistribution.The current unshipped scaffold readers are:
elcf4r_read_ideal()elcf4r_read_gx()The current shipped compact SGSC example artifact is:
elcf4r_sgsc_exampleThe full SGSC 7zip archive and extracted raw CSV are not redistributed.
elcf4r_fit_lstm() does not auto-select a Python interpreter. Configure the
TensorFlow backend explicitly before fitting an LSTM model, for example:
library(reticulate)
library(elcf4R)
elcf4r_use_tensorflow_env(virtualenv = "r-tensorflow", required = TRUE)
# or:
# reticulate::use_virtualenv("r-tensorflow", required = TRUE)
# reticulate::use_python("/path/to/python", required = TRUE)
The package now ships compact example panels and saved benchmark results for
iFlex, StoreNet, Low Carbon London and REFIT, plus a compact Smart-Grid
Smart-City example panel. The main documentation therefore runs without
external downloads. These artifacts are derived from local raw files through
the reproducible scripts in data-raw/.
The current shipped benchmark artifacts are:
15 households, 28 train days, 7 test days1 household (H6_W), 5 train days, 2 test days1 thermosensitive household, 56 train days, 7 test days2 thermosensitive households, 56 train days, 7 test daysThere are more insights and examples in the vignettes.
vignette("elcf4R-iflex-workflow", package = "elcf4R")
vignette("elcf4R-datasets-vignette", package = "elcf4R")
The shipped benchmark artifacts now cover iFlex, StoreNet, Low Carbon London
and REFIT. The same workflow is available programmatically through
elcf4r_build_benchmark_index() and elcf4r_benchmark().
benchmark_summary <- Filter(
Negate(is.null),
list(
.elcf4r_benchmark_summary("elcf4r_iflex_benchmark_results", "iflex"),
.elcf4r_benchmark_summary("elcf4r_storenet_benchmark_results", "storenet"),
.elcf4r_benchmark_summary("elcf4r_lcl_benchmark_results", "lcl"),
.elcf4r_benchmark_summary("elcf4r_refit_benchmark_results", "refit")
)
)
if (length(benchmark_summary) == 0L) {
data.frame()
} else {
do.call(rbind, benchmark_summary)
}
#> data frame with 0 columns and 0 rows