Audit only

.github/workflows/build-Docker-image-triggers.yml

@@ -23,6 +23,9 @@ jobs:
       fail-fast: false
       matrix:
         config-name:
+          - audit_2022Q4
+          - audit_2023Q4
+          - audit_multiple_portfolio_files
           - default_2022Q4
           - default_2023Q4
           - full_params_2022Q4

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: workflow.pacta
 Title: Run PACTA
-Version: 0.0.0.9013
+Version: 0.0.0.9014
 Authors@R: 
     c(person(given = "CJ",
              family = "Yetman",

R/run_pacta.R

@@ -17,13 +17,17 @@
 #' \item timeHorizon: Time horizon for analysis.
 #' }
 #' }
+#' @param run_audit logical: Run the audit process
+#' @param run_analysis logical: Run the analysis process
 #' @param pacta_data_dir filepath: Directory with "pacta-data"
 #' @param output_dir filepath: Directory to save outputs.
 #' @param portfolio_dir filepath: Directory with portfolio files
 #' @return No return value. Saves outputs to output_dir.
 #' @export
 run_pacta <- function(
   params,
+  run_audit = TRUE,
+  run_analysis = TRUE,
   pacta_data_dir = Sys.getenv("PACTA_DATA_DIR"),
   output_dir = Sys.getenv("ANALYSIS_OUTPUT_DIR"),
   portfolio_dir = Sys.getenv("PORTFOLIO_DIR")
@@ -44,35 +48,54 @@
   }
   log_info("Running PACTA")
 
-  audit_prechecks(
-    portfolio_files = params[["portfolio"]][["files"]],
-    pacta_data_dir = pacta_data_dir,
-    portfolio_dir = portfolio_dir,
-    output_dir = output_dir
-  )
-  analysis_prechecks(
-    pacta_data_dir = pacta_data_dir,
-    output_dir = output_dir,
-    check_portfolio = FALSE
-  )
+  audit_file_path <- file.path(output_dir, "audit_file.rds")
 
-  run_audit(
-    portfolio_files = params[["portfolio"]][["files"]],
-    pacta_data_dir = pacta_data_dir,
-    portfolio_dir = portfolio_dir,
-    output_dir = output_dir
-  )
-  run_analysis(
-    pacta_data_dir = pacta_data_dir,
-    output_dir = output_dir,
-    equity_market_list = params[["analysis"]][["equityMarketList"]],
-    scenario_sources_list = params[["analysis"]][["scenarioSourcesList"]],
-    scenario_geographies_list =
-      params[["analysis"]][["scenarioGeographiesList"]],
-    sector_list = params[["analysis"]][["sectorList"]],
-    start_year = params[["analysis"]][["startYear"]],
-    time_horizon = params[["analysis"]][["timeHorizon"]]
-  )
+  if (!file.exists(audit_file_path)) {
+    log_warn("Audit file not found. Running audit.")
+    run_audit <- TRUE
+  }
+
+  if (run_audit) {
+    audit_prechecks(
+      portfolio_files = params[["portfolio"]][["files"]],
+      pacta_data_dir = pacta_data_dir,
+      portfolio_dir = portfolio_dir,
+      output_dir = output_dir
+    )
+  }
+
+  if (run_analysis) {
+    analysis_prechecks(
+      pacta_data_dir = pacta_data_dir,
+      output_dir = output_dir,
+      check_portfolio = FALSE
+    )
+  }
+
+
+  if (run_audit) {
+    run_audit(
+      portfolio_files = params[["portfolio"]][["files"]],
+      pacta_data_dir = pacta_data_dir,
+      portfolio_dir = portfolio_dir,
+      output_dir = output_dir
+    )
+  }
+
+
+  if (run_analysis) {
+    run_analysis(
+      pacta_data_dir = pacta_data_dir,
+      output_dir = output_dir,
+      equity_market_list = params[["analysis"]][["equityMarketList"]],
+      scenario_sources_list = params[["analysis"]][["scenarioSourcesList"]],
+      scenario_geographies_list =
+        params[["analysis"]][["scenarioGeographiesList"]],
+      sector_list = params[["analysis"]][["sectorList"]],
+      start_year = params[["analysis"]][["startYear"]],
+      time_horizon = params[["analysis"]][["timeHorizon"]]
+    )
+  }
 
   log_info("PACTA run complete.")
   return(

docker-compose.yml

@@ -1,8 +1,7 @@
 ---
 services:
   workflow.pacta:
-    # build: .
-    image: ghcr.io/rmi-pacta/workflow.pacta
+    build: .
     # stdin_open: true
     # tty: true
     # entrypoint: ["R", "--args"]

inst/extdata/parameters/analysis_default.json

@@ -1,4 +1,8 @@
 {
+  "commands": {
+    "audit": true,
+    "analysis": true
+  },
   "analysis": {
     "equityMarketList": [
       "GlobalMarket",

inst/extdata/schema/portfolioParameters.json

@@ -6,6 +6,24 @@
   "$comment": "Created by Alex Axthelm, aaxthelm@rmi.org",
   "type": "object",
   "properties": {
+    "commands": {
+      "type": "object",
+      "description": "Commands to run.",
+      "properties": {
+        "audit": {
+          "type": "boolean",
+          "description": "Whether to run the audit."
+        },
+        "analysis": {
+          "type": "boolean",
+          "description": "Whether to run the analysis."
+        }
+      },
+      "required": [
+        "audit",
+        "analysis"
+      ]
+    },
     "portfolio": {
       "$ref": "portfolio.json"
     },
@@ -93,6 +111,7 @@
   "allOf": [
     {
       "required": [
+        "commands",
         "portfolio",
         "analysis"
       ]

inst/extdata/scripts/run_pacta.R

@@ -26,7 +26,11 @@ params <- pacta.workflow.utils::parse_raw_params(
   force_array = c("portfolio", "files")
 )
 
-manifest_info <- workflow.pacta::run_pacta(params)
+manifest_info <- workflow.pacta::run_pacta(
+  params = params,
+  run_audit = params[["commands"]][["audit"]],
+  run_analysis = params[["commands"]][["analysis"]]
+)
 
 pacta.workflow.utils::export_manifest(
   input_files = manifest_info[["input_files"]],

portfolios/default_params.json

@@ -1,4 +1,8 @@
 {
+  "commands": {
+    "audit": true,
+    "analysis": true
+  },
   "portfolio": {
     "holdingsDate": "2023-12-31",
     "files": 

tests/config/audit_2022Q4.json

@@ -0,0 +1,17 @@
+{
+  "holdingsDate": "2022Q4",
+  "pactaDataURL": "https://pactadatadev.file.core.windows.net/workflow-data-preparation-outputs/2022Q4_20240426T113151Z",
+  "parameters": {
+    "commands": {
+      "audit": true,
+      "analysis": false
+    },
+    "portfolio": {
+      "files": [
+        "default_portfolio.csv"
+      ],
+      "holdingsDate": "2022-12-31"
+    },
+    "inherit": "analysis_2022Q4"
+  }
+}

tests/config/audit_2023Q4.json

@@ -0,0 +1,17 @@
+{
+  "holdingsDate": "2023Q4",
+  "pactaDataURL": "https://pactadatadev.file.core.windows.net/workflow-data-preparation-outputs/2023Q4_20240424T120055Z",
+  "parameters": {
+    "commands": {
+      "audit": true,
+      "analysis": false
+    },
+    "portfolio": {
+      "files": [
+        "default_portfolio.csv"
+      ],
+      "holdingsDate": "2023-12-31"
+    },
+    "inherit": "analysis_2023Q4"
+  }
+}

tests/config/audit_multiple_portfolio_files.json

@@ -0,0 +1,18 @@
+{
+  "holdingsDate": "2023Q4",
+  "pactaDataURL": "https://pactadatadev.file.core.windows.net/workflow-data-preparation-outputs/2023Q4_20240424T120055Z",
+  "parameters": {
+    "commands": {
+      "audit": true,
+      "analysis": false
+    },
+    "portfolio": {
+      "files": [
+        "section_1.csv",
+        "section_2.csv"
+      ],
+      "holdingsDate": "2023-12-31"
+    },
+    "inherit": "analysis_2023Q4"
+  }
+}

tests/config/full_params_2022Q4.json

@@ -2,6 +2,10 @@
   "holdingsDate": "2022Q4",
   "pactaDataURL": "https://pactadatadev.file.core.windows.net/workflow-data-preparation-outputs/2022Q4_20240426T113151Z",
   "parameters": {
+    "commands": {
+      "audit": true,
+      "analysis": true
+    },
     "portfolio": {
       "holdingsDate": "2022-12-31",
       "files": [

tests/config/full_params_2023Q4.json

@@ -2,6 +2,10 @@
   "holdingsDate": "2023Q4",
   "pactaDataURL": "https://pactadatadev.file.core.windows.net/workflow-data-preparation-outputs/2023Q4_20240424T120055Z",
   "parameters": {
+    "commands": {
+      "audit": true,
+      "analysis": true
+    },
     "portfolio": {
       "holdingsDate": "2023-12-31",
       "files": [