Export categorize_risk function (#793)

* export categorize risk function * update documentation
2DegreesInvesting · Jun 4, 2024 · 4ed9a3d · 4ed9a3d
1 parent 9e3b51c
commit 4ed9a3d
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -13,6 +13,7 @@ export(.data)
 export(aka)
 export(as_label)
 export(as_name)
+export(categorize_risk)
 export(document_default_value)
 export(document_tilt_profile)
 export(emissions_profile)

diff --git a/R/utils.R b/R/utils.R
@@ -14,6 +14,10 @@ risk_category_levels <- function() {
   c("high", "medium", "low")
 }
 
+#' Categorize a variable into risk categories using low and high thresholds
+#'
+#' @keywords internal
+#' @export
 categorize_risk <- function(x, low_threshold, high_threshold, ...) {
   case_when(
     x > high_threshold ~ "high",

diff --git a/man/categorize_risk.Rd b/man/categorize_risk.Rd