fix documentation

USEPA · Dec 5, 2023 · 35554f8 · 35554f8
1 parent cc63916
commit 35554f8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/R/CalculationFunctions.R b/R/CalculationFunctions.R
@@ -354,6 +354,7 @@ disaggregateTotalToDirectAndTier1 <- function(model, impact, opt_impact="indicat
 #' @param model A complete EEIO model: a list with USEEIO model components and attributes
 #' @param impact str, a model indicator (e.g., "Greenhouse Gases") row index of N, 
 #'                    or elementary flow (e.g., "Methane/emission/air/kg") index of M
+#' @param opt_impact str {'indicator', 'elemflow'}, string code to specify impact type
 #' @return A sector by sector, impact-per-tier-1-purchase matrix.
 calculateTotalImpactbyTier1Purchases <- function(model, impact, opt_impact='indicator') {
   mtx_total <- c("indicator"="N", "elemflow"="M")[opt_impact]

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