Add overall materiality to evaluation table

jasp-stats · Feb 8, 2025 · c43a622 · c43a622
1 parent 2bdb9b6
commit c43a622
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 1 deletion.
diff --git a/R/auditCommonFunctions.R b/R/auditCommonFunctions.R
@@ -2769,12 +2769,16 @@
   table$dependOn(options = c(
     "tableBookDist", "tableDescriptives", "tableSample",
     "samplingChecked", "evaluationChecked", "display",
-    "values.audit", "ir", "irCustom", "cr", "crCustom", "car", "carCustom"
+    "values.audit", "ir", "irCustom", "cr", "crCustom", "car", "carCustom",
+    "overallMateriality", "overallMaterialityType", "overallMaterialityPercentage", "overallMaterialityAmount"
   ))
 
   columnType <- if (options[["display"]] == "percent") "string" else "number"
   table$addColumnInfo(name = "null", title = "", type = "string")
   if (options[["materiality_test"]]) {
+    if (options[["workflow"]] && options[["overallMateriality"]]) {
+      table$addColumnInfo(name = "overall", title = gettext("Overall materiality"), type = columnType)
+    }
     table$addColumnInfo(name = "materiality", title = gettext("Performance materiality"), type = columnType)
   }
   if (options[["min_precision_test"]]) {
@@ -2873,6 +2877,13 @@
       "percent" = paste0(round(prevOptions[["materiality_val"]] * 100, 3), "%"),
       "amount" = prevOptions[["materiality_val"]] * parentState[["N.units"]]
     )
+    if (options[["workflow"]] && options[["overallMateriality"]]) {
+      table[["overall"]] <- switch(options[["display"]],
+        "number" = if (options[["overallMaterialityType"]] == "overallMaterialityAbsolute") options[["overallMaterialityAmount"]] / parentState[["N.units"]] else options[["overallMaterialityPercentage"]],
+        "percent" = if (options[["overallMaterialityType"]] == "overallMaterialityAbsolute") paste0(round(options[["overallMaterialityAmount"]] / parentState[["N.units"]] * 100, 3), "%") else paste0(round(options[["overallMaterialityPercentage"]] * 100, 3), "%"),
+        "amount" = if (options[["overallMaterialityType"]] == "overallMaterialityAbsolute") options[["overallMaterialityAmount"]] else options[["overallMaterialityPercentage"]] * parentState[["N.units"]]
+      )
+    }
   }
 
   if (options[["min_precision_test"]]) {

diff --git a/tests/testthat/test-auditbayesianworkflow.R b/tests/testthat/test-auditbayesianworkflow.R
@@ -62,6 +62,8 @@ options$plotPriorPredictive <- FALSE
 options$plotPosteriorPredictive <- FALSE
 options$plotEstimates <- FALSE
 options$tableCorrections <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- jaspTools::runAnalysis("auditBayesianWorkflow", "test-workflow.csv", options)
 

diff --git a/tests/testthat/test-auditclassicalworkflow.R b/tests/testthat/test-auditclassicalworkflow.R
@@ -52,6 +52,8 @@ options$tableAssumptions <- FALSE
 options$plotEstimates <- FALSE
 options$tableCorrections <- FALSE
 options$plotErrorDist <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- jaspTools::runAnalysis("auditClassicalWorkflow", "test-workflow.csv", options)
 

diff --git a/tests/testthat/test-uvb.R b/tests/testthat/test-uvb.R
@@ -61,6 +61,8 @@ options$indicator_col <- "SelectionResult"
 options$variable_col <- "AuditResult"
 options$annotation <- "continuous"
 options$randomize <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- jaspTools::runAnalysis("auditBayesianWorkflow", "Case2.csv", options)
 
@@ -233,6 +235,8 @@ options$indicator_col <- "selected"
 options$variable_col <- "auditResult"
 options$annotation <- "continuous"
 options$randomize <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- jaspTools::runAnalysis("auditBayesianWorkflow", "uvb-testcase1.csv", options)
 
@@ -354,6 +358,8 @@ options$indicator_col <- "selected"
 options$variable_col <- "auditResult"
 options$annotation <- "continuous"
 options$randomize <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- runAnalysis("auditBayesianWorkflow", "uvb-testcase2.csv", options)
 
@@ -457,6 +463,8 @@ options$indicator_col <- "selected"
 options$variable_col <- "auditResult"
 options$annotation <- "continuous"
 options$randomize <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- jaspTools::runAnalysis("auditBayesianWorkflow", "uvb-testcase3.csv", options)
 
@@ -576,6 +584,8 @@ options$indicator_col <- "selected"
 options$variable_col <- "auditResult"
 options$annotation <- "continuous"
 options$randomize <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- jaspTools::runAnalysis("auditBayesianWorkflow", "uvb-testcase4.csv", options)
 
@@ -680,6 +690,8 @@ options$indicator_col <- "selected"
 options$variable_col <- "auditResult"
 options$annotation <- "continuous"
 options$randomize <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- jaspTools::runAnalysis("auditBayesianWorkflow", "uvb-testcase5.csv", options)
 
@@ -789,6 +801,8 @@ options$indicator_col <- "selected"
 options$variable_col <- "auditResult"
 options$annotation <- "continuous"
 options$randomize <- FALSE
+options$workflow <- TRUE
+options$overallMateriality <- FALSE
 set.seed(1)
 results <- jaspTools::runAnalysis("auditBayesianWorkflow", "uvb-testcase6.csv", options)