From 35554f8c9b03044fbd147b26917fb4f8df0e6d74 Mon Sep 17 00:00:00 2001
From: Ben Young <Ben.Young@erg.com>
Date: Mon, 4 Dec 2023 21:26:00 -0500
Subject: [PATCH] fix documentation

---
 R/CalculationFunctions.R                    | 1 +
 man/calculateTotalImpactbyTier1Purchases.Rd | 2 ++
 2 files changed, 3 insertions(+)

diff --git a/R/CalculationFunctions.R b/R/CalculationFunctions.R
index 61cc6048..e06b6801 100644
--- 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
index ba424922..75d09960 100644
--- a/man/calculateTotalImpactbyTier1Purchases.Rd
+++ b/man/calculateTotalImpactbyTier1Purchases.Rd
@@ -13,6 +13,8 @@ calculateTotalImpactbyTier1Purchases(model, impact, opt_impact = "indicator")
 
 \item{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}
+
+\item{opt_impact}{str {'indicator', 'elemflow'}, string code to specify impact type}
 }
 \value{
 A sector by sector, impact-per-tier-1-purchase matrix.