From a61fc470437229eb0f0704861dfd4f48ecf05985 Mon Sep 17 00:00:00 2001 From: Ben Young Date: Wed, 4 Sep 2024 11:40:06 -0400 Subject: [PATCH] clarify functions #309 --- R/CalculationFunctions.R | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/R/CalculationFunctions.R b/R/CalculationFunctions.R index 186fd875..be0fa7e9 100644 --- a/R/CalculationFunctions.R +++ b/R/CalculationFunctions.R @@ -425,10 +425,10 @@ calculateFlowContributiontoImpact <- function (model, sector, indicator, domesti #' Aggregate result matrix by rows #' -#' @param matrix A matrix with sectors as rows +#' @param matrix A result calculation matrix (e.g. `G` or `H`) with sectors as rows #' @param to_level The level of BEA code this matrix will be aggregated to #' @param crosswalk Sector crosswalk between levels of detail -#' @return An aggregated matrix with sectors as rows +#' @return An aggregated result calculation matrix with sectors as rows aggregateResultMatrixbyRow <- function (matrix, to_level, crosswalk) { # Determine the columns within MasterCrosswalk that will be used in aggregation from_code <- "USEEIO" @@ -449,7 +449,8 @@ aggregateResultMatrixbyRow <- function (matrix, to_level, crosswalk) { #' Aggregate result matrix by rows and columns #' -#' @param matrix A matrix with sectors as rows and columns +#' @param matrix A matrix of inventory or impact results with sectors as both rows and columns, +#' such as the output from calculateSectorPurchasedbySectorSourcedImpact() #' @param to_level The level of BEA code this matrix will be aggregated to #' @param crosswalk Sector crosswalk between levels of detail #' @return An aggregated matrix with sectors as rows and columns