Skip to content

Latest commit

 

History

History
128 lines (94 loc) · 4.74 KB

README.md

File metadata and controls

128 lines (94 loc) · 4.74 KB

evaluator evaluator Logo

R build status Coverage Status CRAN_Status_Badge downloads

Overview

evaluator is an open source quantitative risk analysis toolkit. Based on the OpenFAIR ontology and risk analysis standard, evaluator empowers an organization to perform a quantifiable, repeatable, and data-driven risk review.

Three sample outputs of this toolkit are available:

  1. A sample risk analysis report
  2. A one page risk dashboard
  3. A demonstration copy of Scenario Explorer

Installation

Install evaluator via the standard CRAN mechanisms. If you wish to use the optional, but recommended, reporting functions, also install the suggested dependencies. These additional packages are not needed for modeling, but are used in the generation of reports.

install.packages("evaluator", dependencies = TRUE)

If you wish to run the development (and potentially bleeding edge) version of evaluator, you can install directly from GitHub with the following devtools command.

# install.pacakges("devtools")
devtools::install_github("davidski/evaluator", dependencies = TRUE)

Optionally, Docker images with all dependencies pre-installed are available on the Docker Hub.

Usage

The primary workflow for evaluator involves gathering data in Excel then running the analysis from within the R and Evaluator environment:

From Excel:

  1. Populate the evaluator-supplied data acquisition spreadsheet

From Evaluator:

  1. Import the data
  2. Prepare the data for simulation
  3. Run the simulations
  4. Summarize the results
  5. Generate draft reports for customization

A detailed guide is available in the vignette accessed via vignette("usage", package="evaluator"). A short screencast showing the basic workflow (not including generation of reports) is available below:

demo

Where to Go from Here

While evaluator is a powerful tool, it does not attempt to address interactions between risk scenarios, rolling up multiple levels of risk into aggregations, or other advanced topics. As you become more comfortable with quantitative risk analysis, you may wish to dive deeper into these areas (and I hope you do!). The following resources may help you explore these and other topics in risk management.

Alternative Software

  • RiskLens, a commercial analysis suite, founded by the original creator of the FAIR methodology
  • FAIR Tool, a Shiny and R based two scenario simulator, authored by Ezeugo Aguta under an MIT license
  • FAIR-U, a free educational tool for learning FAIR analysis, powered by RiskLens
  • Open FAIR Risk Analysis Tool, an Excel and SIPMath base tool with a limited open license

Blogs/Books/Training

Associations

Contributing

This project is governed by a Code of Conduct. By participating in this project you agree to abide by these terms.

License

The MIT License applies.