sweep: Sweep out array summaries (generic)

View source: R/S3_matvec.R

sweepR Documentation

Sweep out array summaries (generic)

Description

S3 generic for sweep(). Dispatches to sweep.HDF5Matrix for HDF5Matrix objects, and to base::sweep() for all others.

Usage

sweep(x, MARGIN, STATS, FUN = "-", check.margin = TRUE, ...)

Arguments

x

A matrix or HDF5Matrix object.

MARGIN

Integer. 1 for rows, 2 for columns.

STATS

Numeric vector to sweep out.

FUN

Character. Function to apply: "-", "+", etc.

check.margin

Logical. Check that STATS length matches margin.

...

Additional arguments passed to the method.

Value

A new HDF5Matrix or matrix with STATS swept out.


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