From 336cc55e0484ba089d9fe68a10491f46e646ede9 Mon Sep 17 00:00:00 2001
From: Ben Young <ben.young@erg.com>
Date: Fri, 16 Aug 2024 11:50:32 -0400
Subject: [PATCH] udpate documentation

---
 R/CalculationFunctions.R                   | 3 ++-
 man/calculateEEIOModel.Rd                  | 6 +++++-
 man/calculateResultsWithExternalFactors.Rd | 5 ++++-
 3 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/R/CalculationFunctions.R b/R/CalculationFunctions.R
index 982563f9..efe60522 100644
--- a/R/CalculationFunctions.R
+++ b/R/CalculationFunctions.R
@@ -14,7 +14,7 @@
 #' if FALSE, use complete demand and L matrix.
 #' @param household_emissions, bool, if TRUE, include calculation of emissions from households
 #' @param show_RoW, bool, if TRUE, include rows for commodities in RoW, e.g. `111CA/RoW` in result objects.
-#'  Only valid currently for models with ExternalImportFactors. 
+#' Only valid currently for models with ExternalImportFactors.
 #' @export
 #' @return A list with LCI and LCIA results (in data.frame format) of the EEIO model.
 calculateEEIOModel <- function(model, perspective, demand = "Production", location = NULL,
@@ -125,6 +125,7 @@ prepareDemandVectorForImportResults <- function(model, demand = "Production", lo
 #' @param location, str optional location code for demand vector, required for two-region models
 #' @param use_domestic_requirements bool, if TRUE, return only domestic portion of results
 #' @param household_emissions, bool, if TRUE, include calculation of emissions from households
+#' @param show_RoW, bool, if TRUE, include rows for commodities in RoW, e.g. `111CA/RoW` in result objects.
 #' @return A list with LCI and LCIA results (in data.frame format) of the EEIO model.
 calculateResultsWithExternalFactors <- function(model, perspective = "FINAL", demand = "Consumption", location = NULL,
                                                 use_domestic_requirements = FALSE, household_emissions = FALSE,
diff --git a/man/calculateEEIOModel.Rd b/man/calculateEEIOModel.Rd
index 05f2cd24..467d7dc2 100644
--- a/man/calculateEEIOModel.Rd
+++ b/man/calculateEEIOModel.Rd
@@ -11,7 +11,8 @@ calculateEEIOModel(
   demand = "Production",
   location = NULL,
   use_domestic_requirements = FALSE,
-  household_emissions = FALSE
+  household_emissions = FALSE,
+  show_RoW = FALSE
 )
 }
 \arguments{
@@ -31,6 +32,9 @@ numeric values in USD with the same dollar year as model.}
 if FALSE, use complete demand and L matrix.}
 
 \item{household_emissions, }{bool, if TRUE, include calculation of emissions from households}
+
+\item{show_RoW, }{bool, if TRUE, include rows for commodities in RoW, e.g. `111CA/RoW` in result objects.
+Only valid currently for models with ExternalImportFactors.}
 }
 \value{
 A list with LCI and LCIA results (in data.frame format) of the EEIO model.
diff --git a/man/calculateResultsWithExternalFactors.Rd b/man/calculateResultsWithExternalFactors.Rd
index cae7f106..2c3cbfd9 100644
--- a/man/calculateResultsWithExternalFactors.Rd
+++ b/man/calculateResultsWithExternalFactors.Rd
@@ -12,7 +12,8 @@ calculateResultsWithExternalFactors(
   demand = "Consumption",
   location = NULL,
   use_domestic_requirements = FALSE,
-  household_emissions = FALSE
+  household_emissions = FALSE,
+  show_RoW = FALSE
 )
 }
 \arguments{
@@ -29,6 +30,8 @@ results with the sectors consumed by the final user.}
 \item{use_domestic_requirements}{bool, if TRUE, return only domestic portion of results}
 
 \item{household_emissions, }{bool, if TRUE, include calculation of emissions from households}
+
+\item{show_RoW, }{bool, if TRUE, include rows for commodities in RoW, e.g. `111CA/RoW` in result objects.}
 }
 \value{
 A list with LCI and LCIA results (in data.frame format) of the EEIO model.