ERTMonCollapseFeatureMatrices: Get feature sub-matrices collapsed.

In antononcube/ERTMon-R: Event Records Transformations Monad

Description

Get feature sub-matrices collapsed.

Usage

ERTMonCollapseFeatureMatrices(
  ertObj,
  matrixNames = NULL,
  entityIDs = NULL,
  collapseFunction = colSums,
  completeColumnRangeQ = FALSE
)

Arguments

ertObj	An ERTMon object.
matrixNames	A character vector with names of feature sub-matrices to be collapsed. If NULL then all feature sub-matrices are collapsed.
entityIDs	A character vector with entity ID's (that feature sub-matrices row names.) If NULL then all entity ID's are used.
collapseFunction	A function that can be applied to a sparse matrix.
completeColumnRangeQ	See ERTMonTakeContingencyMatrices.

Details

Collapses specified feature sub-matrices with a specified function. The collapse function can be one of rowSums, rowMeans, colSums, colMeans or any other function that can be applied.

The obtained list of collapsed matrices is assigned to ertObj$Value. This function is fairly simple – it was programmed in order to have the corresponding operation explicitly named in formula computation workflows.

Value

An ERTMon object.

See Also

Other Feature matrices: ERTMonPlotFeatureMatrices(), ERTMonStackFeatureMatrices()

antononcube/ERTMon-R documentation built on Oct. 14, 2021, 2:27 p.m.