raveio (version 0.9.0)

collapse2: Collapse high-dimensional tensor array

Description

Collapse high-dimensional tensor array

Usage

collapse2(x, keep, method = c("mean", "sum"), ...)
# S3 method for FileArray
collapse2(x, keep, method = c("mean", "sum"), ...)
# S3 method for Tensor
collapse2(x, keep, method = c("mean", "sum"), ...)
# S3 method for array
collapse2(x, keep, method = c("mean", "sum"), ...)

Value

A collapsed array (or a vector or matrix), depending on keep

Arguments

x

R array, FileArray-class, or Tensor object

keep

integer vector, the margins to keep

method

character, calculates mean or sum of the array when collapsing

...

passed to other methods

See Also

collapse

Examples

x <- array(1:16, rep(2, 4))

collapse2(x, c(3, 2))

# Alternative method, but slower when `x` is a large array
apply(x, c(3, 2), mean)

# filearray
y <- filearray::as_filearray(x)

collapse2(y, c(3, 2))

collapse2(y, c(3, 2), "sum")

# clean up
y$delete(force = TRUE)