README.md

In ConvergenceDA/visdomloadshape: R package for load shape clustering and analysis, extending the visdom package

visdomloadshape

This package provides load shape clustering tools that extend the capabilities of the VISDOM load data analysis R package. This code implements the methods described in the original paper Household Energy Consumption Segmentation Using Hourly Data, written by Jungsuk Kwac, June Flora, and Ram Rajagopal, all of Professor Rajagopal's Stanford Sustainable Systems Lab. To install, follow these steps:

1. Install the R module 'visdom' following instructions found here: https://github.com/convergenceda/visdom and ensure that you can load the visdom package. The upshot is that you should be able to install visdom using devtools::install_github('convergenceda/visdom'), but you will need to ensure that you have first installed devtools and depending on your planned usage there are other ways to do it.

2. Install the visdomloadshape package. With devtools installed, this command should suffice: devtools::install_github('convergenceda/visdomloadshape'). For more details, refer to the instructions in install_visdomloadshape.rmd

See the code in the vignettes directory, especially the R markdown file example_load_shape_analysis.rmd. Note: rmd's mix commentary and code and this one will give you a sense of what is required to run load shape clustering on a given sample of meter data.

ConvergenceDA/visdomloadshape documentation built on May 8, 2019, 8:34 a.m.