sweep

S3 generic for <code><a href="/link/sweep()?package=BigDataStatMeth&version=2.0.3" data-mini-rdoc="BigDataStatMeth::sweep()">sweep()</a></code>. Dispatches to <code>sweep.HDF5Matrix</code>
for <code>HDF5Matrix</code> objects, and to <code><a href="/link/base%3A%3Asweep()?package=BigDataStatMeth&version=2.0.3" data-mini-rdoc="BigDataStatMeth::base::sweep()">base::sweep()</a></code> for all others.

A framework for 'scalable' statistical computing on large on-disk
matrices stored in 'HDF5' files. It provides efficient block-wise
implementations of core linear-algebra operations (matrix multiplication,
SVD, PCA, and QR decomposition) written in C++ and R, along with building
blocks from which higher-level multivariate methods such as canonical
correlation analysis can be constructed. These building blocks are designed
not only for direct use, but also as foundational components for developing
new statistical methods that must operate on datasets too large to fit in
memory. The package supports data provided either as 'HDF5' files or
standard R objects, and is intended for high-dimensional applications such
as 'omics' and precision-medicine research.

Dolors Pelegri-Siso

BigDataStatMeth

Scalable Statistical Computing with HDF5-Backed Matrices

Juan R. Gonzalez

sweep function

<dl><dt>x</dt>
<dd>A matrix or <code>HDF5Matrix</code> object.</dd>
<dt>MARGIN</dt>
<dd>Integer. <code>1</code> for rows, <code>2</code> for columns.</dd>
<dt>STATS</dt>
<dd>Numeric vector to sweep out.</dd>
<dt>FUN</dt>
<dd>Character. Function to apply: <code>"-"</code>, <code>"+"</code>, etc.</dd>
<dt>check.margin</dt>
<dd>Logical. Check that <code>STATS</code> length matches margin.</dd>
<dt>...</dt>
<dd>Additional arguments passed to the method.</dd></dl>

Arguments

S3 generic for <code><a href='https://rdrr.io/r/base/sweep.html'>sweep()</a></code>. Dispatches to <code>sweep.HDF5Matrix</code>
for <code>HDF5Matrix</code> objects, and to <code><a href='https://rdrr.io/r/base/sweep.html'>base::sweep()</a></code> for all others.

Sweep out array summaries (generic) — sweep

<dl>

<dt>x</dt>
<dd>A matrix or <code>HDF5Matrix</code> object.</dd>


<dt>MARGIN</dt>
<dd>Integer. <code>1</code> for rows, <code>2</code> for columns.</dd>


<dt>STATS</dt>
<dd>Numeric vector to sweep out.</dd>


<dt>FUN</dt>
<dd>Character. Function to apply: <code>"-"</code>, <code>"+"</code>, etc.</dd>


<dt>check.margin</dt>
<dd>Logical. Check that <code>STATS</code> length matches margin.</dd>


<dt>...</dt>
<dd>Additional arguments passed to the method.</dd>

</dl>

sweep: Sweep out array summaries (generic)

Description

Usage

Value

Arguments