diff --git a/R/CalculationFunctions.R b/R/CalculationFunctions.R index bf74a80e..ff6242f3 100644 --- a/R/CalculationFunctions.R +++ b/R/CalculationFunctions.R @@ -426,10 +426,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" @@ -450,7 +450,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 diff --git a/man/aggregateResultMatrix.Rd b/man/aggregateResultMatrix.Rd index 15080cd9..1b11d984 100644 --- a/man/aggregateResultMatrix.Rd +++ b/man/aggregateResultMatrix.Rd @@ -7,7 +7,8 @@ aggregateResultMatrix(matrix, to_level, crosswalk) } \arguments{ -\item{matrix}{A matrix with sectors as rows and columns} +\item{matrix}{A matrix of inventory or impact results with sectors as both rows and columns, +such as the output from calculateSectorPurchasedbySectorSourcedImpact()} \item{to_level}{The level of BEA code this matrix will be aggregated to} diff --git a/man/aggregateResultMatrixbyRow.Rd b/man/aggregateResultMatrixbyRow.Rd index 9af4b266..15302bb2 100644 --- a/man/aggregateResultMatrixbyRow.Rd +++ b/man/aggregateResultMatrixbyRow.Rd @@ -7,14 +7,14 @@ aggregateResultMatrixbyRow(matrix, to_level, crosswalk) } \arguments{ -\item{matrix}{A matrix with sectors as rows} +\item{matrix}{A result calculation matrix (e.g. `G` or `H`) with sectors as rows} \item{to_level}{The level of BEA code this matrix will be aggregated to} \item{crosswalk}{Sector crosswalk between levels of detail} } \value{ -An aggregated matrix with sectors as rows +An aggregated result calculation matrix with sectors as rows } \description{ Aggregate result matrix by rows