HDF5Matrix-scalar-aggregations: Summary statistics for HDF5Matrix

In BigDataStatMeth: Title: Scalable Statistical Computing with HDF5-Backed Matrices

Summary statistics for HDF5Matrix

Description

Scalar aggregations over all elements of an HDF5 matrix, computed block-wise without loading the full data into RAM.

Usage

## S3 method for class 'HDF5Matrix'
mean(
  x,
  na.rm = FALSE,
  paral = NULL,
  wsize = NULL,
  threads = NULL,
  save_to = NULL,
  overwrite = TRUE,
  ...
)

## S3 method for class 'HDF5Matrix'
Summary(..., na.rm = FALSE)

Arguments

x	An HDF5Matrix object.
na.rm	Ignored (included for generic compatibility).
paral	Logical or NULL. Enable OpenMP parallelisation.
wsize	Integer or NULL. Block size (NULL = auto).
threads	Integer or NULL. Number of threads (NULL = auto).
save_to	Optional persistence target (same format as colSums.HDF5Matrix).
overwrite	Logical. Overwrite existing dataset when saving.
...	For Summary methods: additional objects (currently not supported; raises an error if supplied).

Value

A scalar numeric (when save_to = NULL) or an HDF5Matrix pointing to a 1×1 persisted dataset.

BigDataStatMeth documentation built on May 15, 2026, 1:07 a.m.