inst/run_analysis.R

In evaluator: Quantified Risk Assessment Toolkit

# Quick Start script for Evaluator workflow
# Process documented at https://evaluator.tidyrisk.org/articles/usage.html

# This script is intended as a starting point for taking a directory of
# inputs as created by evaluator::create_templates(), running simulations,
# saving the result details & summary files, and preparing the default static
# reports. The analyst MUST edit the template input files before running
# this script to produce valid results.

# Committing this script, along with the other contents of the base evaluator
# directory, to source control provides a reproducable set of inputs & outputs
# for a single analysis.

# Setup -------------------------------------------------------------------
library(evaluator)
library(readr)
library(purrr)
library(dplyr)
library(furrr)
plan(multiprocess)

if (!exists("base_dir") || !dir.exists(base_dir)) {
  stop("Set base_dir to your evaluator working directory before running this script.")
}

inputs_dir <- file.path(base_dir, "inputs")
results_dir <- file.path(base_dir, "results")

message("Beginning analysis run with input directory (", inputs_dir, ")",
        " and results directory (", results_dir, ")...")

# Load and Validate -------------------------------------------------------
message("Loading and validating inputs...")

domains <- read_csv(file.path(inputs_dir, "domains.csv"),
                    col_types = cols(.default = col_character()))
import_spreadsheet(file.path(inputs_dir, "survey.xlsx"), domains, inputs_dir)

qual_inputs <- read_qualitative_inputs(inputs_dir)
qualitative_scenarios <- qual_inputs$qualitative_scenarios
mappings <- qual_inputs$mappings
capabilities <- qual_inputs$capabilities
validate_scenarios(qualitative_scenarios, capabilities, domains, mappings)

# Encode ------------------------------------------------------------------
message("Encoding qualitative scenarios...")
quantitative_scenarios <- encode_scenarios(qualitative_scenarios, capabilities,
                                           mappings)
saveRDS(quantitative_scenarios,
        file = file.path(inputs_dir, "quantitative_scenarios.rds"))

# Simulate ----------------------------------------------------------------
message("Running simulations...")
simulation_results <- quantitative_scenarios %>%
  mutate(results = furrr::future_map(scenario, run_simulation,
                                     iterations = 10000L, .progress = TRUE)) %>%
  select(-c(scenario, tcomm, scenario_description), scenario_id, domain_id, results)
saveRDS(simulation_results, file = file.path(results_dir, "simulation_results.rds"))

# Summarize ---------------------------------------------------------------
message("Summarizing results...")
summarize_to_disk(simulation_results = simulation_results, results_dir)

# Report ---------------------------------------------------------------
message("Generating reports...")

## Risk Dashboard
risk_dashboard(inputs_dir, results_dir,
               file.path(results_dir, "risk_dashboard.html"))

## Long Form Report
generate_report(inputs_dir, results_dir,
                file.path(results_dir, "risk_report.docx"),
                format = "word")

message("Analysis complete.")