R/MeanListDim.R

In s2dverification: Set of Common Tools for Forecast Verification

#'Averages An Array Along Multiple Dimensions
#'
#'Averages an array along a set of dimensions given by the argument dims.
#'
#'@param var Input array.
#'@param dims List of dimensions to average along.
#'@param narm Ignore NA (TRUE) values or not (FALSE).
#'
#'@return The averaged array, with the dimensions specified in \code{dims} 
#'  removed.
#'
#'@keywords datagen
#'@author History:\cr
#'0.1  -  2011-04  (V. Guemas)  -  Original code\cr
#'1.0  -  2013-09  (N. Manubens)  -  Formatting to R CRAN\cr
#'1.1  -  2015-03  (N. Manubens)  -  Improved memory usage
#'@examples
#'a <- array(rnorm(24), dim = c(2, 3, 4))
#'print(a)
#'print(Mean1Dim(a, 2))
#'print(MeanListDim(a, c(2, 3)))
#'@export
MeanListDim <- function(var, dims, narm = TRUE) {
  apply(var, setdiff(c(1:length(dim(var))), dims), mean, na.rm = narm)
}