baeda-polito / student-energy-dashboard

Provides an interactive energy data analytics dashboard to inspect data and perform advanced data mining analysis. It is an open source project promoted by BAEDA Lab in the framework of MSC thesis courses at Politecnico di Torino (Italy)

Explore the docs »
View Demo · Report Bug · Request Feature

---

This project consists in the design and development of interactive dashboards for the analysis of buildings energy data. In particular, we propose to interact with the data in a deeper way by providing different level of data manipulation, from simple pre-processing tasks to advanced methods (e.g., clustering).

The user can modify the models hyper-parameters directly from the UI, giving a great flexibility in the exploration.

Table of Contents

• Getting Started
  • shinyapps.io (Online)
  • AWS (Online)
  • Package Version (Local)
  • Version Control (Local)
• Contributing
• Author
• Acknowledgements

Getting Started

The eDASH can be accessed in many different way depending on the user. We provide an online version for base users who can access the service with no software requirements, a local access by installing the dashboard as an R package for intermediate and finally a version control installation for developer and contributors.

shinyapps.io (Online)

From this link it is possible to access and use the dashboard online without having R or Rstudio installed on your computer. Thanks to shinyapps.io the whole application is hosted online and accessible without any requirements other than an internet connection.

Warning: Since the online hosting is performed through the free account, a limit of 25 active hours is set from the server. If this limit is exceded the app will not be available untill the next month cycle. Therefore, we suggest to exploit the dashboard functionalities by cloning the repository on your local machines as explained in the following.

Package Version (Local)

This kind of installation is suitable for those who have the permission to download the code and want to run the dashboard locally as if it was a R package. Since the code is hosted on a private GitHub repository the user must have the permissions

Install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("https://github.com/baeda-polito/dashboard-student")

Then you can run the application by simply typing in the console:

library("eDASH")
eDASH::run_app()

Version Control (Local)

This kind of installation is suitable for developers who have the permission access the private GitHub repository and download the full code. The process described allows you to get the whole GitHub repository on your computer.

Be sure to have the latest version of RStudio installed, then follow these steps:

1. In RStudio, start a new Project by following this path “File > New Project > Version Control > Git”;
2. In “Repository URL”, paste this URL https://github.com/baeda-polito/dashboard-student;
3. Accept the default “Project directory name” which coincides with the GitHub repo name dashboard-student;
4. Chose a local path to save the repository on your computer;
5. Click “Create Project”.

Now you have cloned the repository and you can contribute!

Contributing

Any contributions you make are greatly appreciated. If you want to propose a feature or report a bug please open a new issue. If you want to contribute to the code, follow these steps:

1. Create your Feature Branch, called for example MYBRANCH (git checkout -b feature/MYBRANCH);
2. Commit your Changes (git commit -m 'Add some AmazingFeature');
3. Push to the Branch (git push origin feature/MYBRANCH);
4. Open a Pull Request.

In this project we follow a defined convection for branch names, so please follow it. The main branch is called main and is the online branch. If you want to contribute on one module for example the clustering module, please call the branch.

Contributors

• Prof. Alfonso Capozzoli, Coordinator of BAEDA Lab , Politecnico di Torino;
• Ing. Roberto Chiosa, PhD Student at BAEDA Lab, Politecnico di Torino;

Acknowledgements

• RStudio
• Shiny
• shinyapps.io
• Shinydashboard

student-energy-dashboard's Issues

Units of measure

make a list of possible units of measure available at all-app level.

Useful to create dropdown with units grouped

filter columns

implement the possibility to filter columns datatables. Could be done through colvis buttons

Discard clusters

Font Awesome deprecated icons

When running the following warning is displayed for different icons. Update needed

This Font Awesome icon ('sync') does not exist:
* if providing a custom `html_dependency` these `name` checks can 
  be deactivated with `verify_fa = FALSE`

Substitute LICORS package

Package LICORS does not exist anymore. Find an alternative.

To install the package anyway go to https://cran.r-project.org/web/packages/LICORS/index.html (other dipendecies mus to be install with LICORS. Follow the console instructions)