sweep

AGGREGATIONS

1 Description

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

2 Usage

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

3 Arguments

Parameter	Description
`x`	A matrix or object.
`MARGIN`	Integer. for rows, for columns.
`STATS`	Numeric vector to sweep out.
`FUN`	Character. Function to apply: , , etc.
`check.margin`	Logical. Check that length matches margin.

4 Value

A new or matrix with swept out.

---
title: "sweep"
subtitle: "sweep"
---

<span class="category-badge aggregations">AGGREGATIONS</span>

## Description

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

## Usage

```r
sweep(x, MARGIN, STATS, FUN = "-", check.margin = TRUE, ...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | A matrix or \code{HDF5Matrix} object. |
| `MARGIN` | Integer. \code{1} for rows, \code{2} for columns. |
| `STATS` | Numeric vector to sweep out. |
| `FUN` | Character. Function to apply: \code{"-"}, \code{"+"}, etc. |
| `check.margin` | Logical. Check that \code{STATS} length matches margin. |
:::

## Value

::: {.return-value}
A new \code{HDF5Matrix} or matrix with \code{STATS} swept out.
:::