SOLDIER: SOLution for Dam Behavior Interpretation and Safety Evaluation

SOLDIER is an interactive application based on R-Shiny that facilitates the generation of machine-learning-based predictive models, their accuracy evaluation, and the analysis of the effect of predictor variables on dam behavior. This tool is designed to support dam engineers in identifying changes in dam response, detecting potential anomalies and better understanding the effect of loads on the dam structure.

SOLDIER aims to facilitate the application and interpretation of machine learning models. Although it is focused on the dam engineering, their functionalities can be extended to structural health monitoring for other civil infrastructures and other problems that can be solved with data-driven models.

Table of Contents

1. Introduction
2. Features
3. Installation and Launch Guide
4. License

Introduction

SOLDIER, which stands for SOLution for Dam behavior Interpretation and safety Evaluation with boosted Regression trees, is an application that allows engineers to harness the power of machine learning in to analyze dam monitoring data, build predictive models and support decicion-making in dam safety assessments. This interactive tool is built using R-Shiny and offers the capability to create predictive models, assess their accuracy, and gain valuable insights into the influence of predictor variables on the dam behavior.

Features

The application is structured into three main sections:

1. Data Exploration:

   • Load data from RDS or XLSX files.
   • Visualize data in different formats: scatterplots and time series.

2. Model Fitting:

   • Select target and predictor variables from the loaded data.
   • Control training and testing data split.
   • Generate predictive models using the Boosted Regression Trees (BRT) algorithm.
   • Assess model accuracy: Mean Absolute Error (MAE) and R-squared (R2) metrics.
   • Interactive graphical representation of predictions and observations.
   • Download fitted models in RDS format for integration or further analysis.

3. Interpretation:

   • Analyze the relative importance of variables in the fitted models.
   • Group variables and analyze their combined influence on the response.
   • Explore the partial dependence of the target variable on selected predictors.
   • Download variable importance and partial dependence results in CSV format.

Installation and Launch Guide

SOLDIER operates like any R-Shiny application. Some users may prefer to clone the repository to have access to the source code for modification and further exploration, while others may simply want to run the application without cloning it. Below are instructions to run SOLDIER on a local machine for both approaches:

Cloning the Repository

1. Clone the Repository:

   git clone https://github.com/your-username/soldier.git
   

2. Install R: R version 4.3.1 or later is required. It can be downloaded from the official R website: https://cran.rstudio.com/.

3. Install RStudio: RStudio provides an integrated development environment for working with R. The latest version of RStudio can be downloaded from their official website: https://www.rstudio.com/products/rstudio/.

4. Run the Application:

   • Open RStudio on your machine.
   • Navigate to the cloned soldier directory and open ui.R file.
   • Press the "Run App" button within RStudio.
   • The first time the application is run, the necessary packages are installed, which may take some time.

5. Access the Application: The application will open in the default web browser.

Without cloning the Repository

1. Install R: R version 4.3.1 or later is required. It can be downloaded from the official R website: https://cran.rstudio.com/.

2. Install RStudio: RStudio provides an integrated development environment for working with R. The latest version of RStudio can be downloaded from their official website: https://www.rstudio.com/products/rstudio/.

3. Run the Application: Execute the command shiny::runGitHub("SOLDIER", "cimnemadrid").

4. Access the Application: The application will open in the default web browser.

More information and support for the installation process is available in the project's documentation.

License

SOLDIER is distributed under the GNU Affero General Public License v3.0 (AGPL-3.0). This license is designed to ensure that users who interact with the software over a network, such as through a web application, also have access to the source code. It grants you the freedom to use, modify, and distribute SOLDIER under the terms and conditions outlined in the AGPL-3.0 license.

For more details about the rights and restrictions imposed by the AGPL-3.0 license, please refer to the LICENSE file in this repository.

---

Disclaimer: SOLDIER is provided "as-is" and without any warranty. The developers make no guarantees regarding the accuracy, reliability, or suitability of the software for any particular purpose.

In no event shall the developers of SOLDIER be liable for any direct, indirect, incidental, special, exemplary, or consequential damages, including but not limited to loss of data, profits, or business interruption, resulting from the use or inability to use the SOLDIER software.

The user assumes full responsibility for the use of materials or information obtained from this application. Any service, repair, or correction of equipment or data required as a result of using SOLDIER is the sole responsibility of the user.

For assistance or support, please feel free to open an issue in this repository or contact us at [email protected]. However, please note that response times and support availability may vary.