Adds disaggregation of two-region model objects

.github/workflows/save-two-region-model-data.yaml

@@ -3,6 +3,13 @@ name: Save two-region data as .rds in parallel runs
 
 on:
   workflow_dispatch: # allow manual trigger
+    inputs:
+        model_spec:
+            description: "Model spec file (in quotes)"
+            required: true
+            default: "StateIOv1.2-shoofly"
+            type: string
+
 
 jobs:
   generate-save-data:
@@ -32,7 +39,7 @@ jobs:
       # R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -59,12 +66,13 @@ jobs:
         run: |
           devtools::load_all()
           year <- ${{ matrix.data-year }}
+          model_spec <- ${{ github.event.inputs.model_spec }}
           source("${{ matrix.script-run }}")
         shell: Rscript {0}
 
       # Upload .rds files
       - name: Upload .rds files and prepare zip for manual download
-        uses: actions/upload-artifact@v2.3.0
+        uses: actions/upload-artifact@v4
         with:
           # Artifact name
           name: data and metadata
@@ -75,7 +83,7 @@ jobs:
 
       # Upload .json files 
       - name: Upload .json files and prepare zip for manual download
-        uses: actions/upload-artifact@v2.3.0
+        uses: actions/upload-artifact@v4
         with:
           # Artifact name
           name: data and metadata

.gitignore

@@ -3,3 +3,4 @@
 .RData
 .Ruserdata
 inst/doc/**/*.html
+work

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: stateior
 Type: Package
 Title: US State Input-Output (stateio) R modeling software
-Version: 0.2.1
+Version: 0.3.0
 Date: 2022-10-20
 Authors@R: c(
   person("Mo", "Li", email="[email protected]", role="aut"),
@@ -40,10 +40,10 @@ Imports:
 Depends:
   R (>= 3.6)
 Remotes:
-  github::USEPA/useeior@v1.1.0
+  github::USEPA/useeior@two_region_disagg
 License: file LICENSE
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.2.0
+RoxygenNote: 7.3.1
 Suggests:
     testthat (>= 2.1.0)

R/InteregionalCommodityFlowFunctions.R

@@ -96,10 +96,11 @@ calculateLocalandTradedRatios <- function(state, year, SoI = TRUE, ioschema, iol
 #' sensitivity analysis on ICF, default is FALSE.
 #' @param adjust_by A numeric value between 0 and 1 indicating the manual adjustment
 #' to ICF if a sensitivity analysis is conducted, default is 0 due to no SA.
+#' @param disagg optional, disaggregation specs
 #' #' @return A data frame contains domestic 2 region ICFs.
 generateDomestic2RegionICFs <- function(state, year, ioschema, iolevel,
                                         ICF_sensitivity_analysis = FALSE,
-                                        adjust_by = 0) {
+                                        adjust_by = 0, disagg = NULL) {
   # Specify BEA code
   bea <- paste("BEA", ioschema, iolevel, "Code", sep = "_")
   # Generate SoI-RoUS commodity flow ratios from FAF
@@ -142,14 +143,34 @@ generateDomestic2RegionICFs <- function(state, year, ioschema, iolevel,
   # Merge ICF_2r_wide with complete BEA Commodity list
   CommodityCodeName <- loadDatafromUSEEIOR(paste(iolevel,
                                                  "CommodityCodeName_2012",
-                                                 sep = "_"))
+                                                 sep = "_"),
+                                           appendSchema = FALSE)
+  # Update commodities from disaggregation
+  if (!is.null(disagg)){
+    disagg_df <- data.frame(BEA_2012_Summary_Commodity_Code = c("221100", "221200", "221300"),
+                         BEA_2012_Summary_Commodity_Name = c("Elec", "NG", "Water"))
+    CommodityCodeName <- CommodityCodeName[CommodityCodeName$BEA_2012_Summary_Commodity_Code!="22",]
+    CommodityCodeName <- rbind(CommodityCodeName, disagg_df)
+  }
+
   ICF <- merge(ICF_2r_wide, CommodityCodeName, by.x = bea,
                by.y = paste("BEA", ioschema, iolevel, "Commodity_Code", sep = "_"),
                all.y = TRUE)
   if (iolevel == "Summary") {
     # Adjust utilities
-    ICF[ICF[, bea] == "22", cols] <- calculateUtilitiesFlowRatios(state, year)[, cols]
-    ICF[ICF[, bea] == "22", "source"] <- "EIA"
+    if (is.null(disagg)){
+      ICF[ICF[, bea] == "22", cols] <- calculateUtilitiesFlowRatios(state, year)[, cols]
+      ICF[ICF[, bea] == "22", "source"] <- "EIA"      
+    } else {
+      ICF[ICF[, bea] == "221100", cols] <- calculateElectricityFlowRatios(state, year)[, cols]
+      ICF[ICF[, bea] == "221100", "source"] <- "EIA"
+      ICF[ICF[, bea] %in% c("221200", "221300"), cols] <- data.frame("SoI2SoI" = 1,
+                                                                     "SoI2RoUS" = 0,
+                                                                     "RoUS2SoI" = 0,
+                                                                     "RoUS2RoUS" = 1) 
+      ICF[ICF[, bea]%in% c("221200", "221300"), "source"] <- "Assuming no interregional trade"        
+    }
+
     # Adjust waste management and remediation services
     ICF[ICF[, bea] == "562", cols] <- calculateWasteManagementServiceFlowRatios(state, year)[, cols]
     ICF[ICF[, bea] == "562", "source"] <- "RCRAInfo and SMP"