colSums

colSums

AGGREGATIONS

1 Usage

colSums(x, na.rm = FALSE, dims = 1L, ...)

2 Arguments

Parameter	Description
`x`	An object.
`na.rm`	Ignored (included for compatibility with the base generic).
`dims`	Ignored (included for compatibility with the base generic).
`paral`	Logical or NULL. Enable OpenMP parallelisation.
`wsize`	Integer or NULL. Block size for HDF5 reads (NULL = auto).
`threads`	Integer or NULL. Number of OpenMP threads (NULL = auto).
`save_to`	Where to save the result (see Details). NULL returns a plain R vector; a character string saves in the same file as ; a named list saves in a different file. In both non-NULL cases an handle is returned.
`overwrite`	Logical. Overwrite an existing dataset at ? (Currently always TRUE when is not NULL.)

3 Value

A numeric vector (when ) or an handle to the persisted result.

4 Examples

\donttest{
tmp <- tempfile(fileext = ".h5")
X <- hdf5_create_matrix(tmp, "data/M", data = matrix(rnorm(200), 20, 10))
cs <- colSums(X)         # R vector
hdf5_close_all()
unlink(tmp)
}

---
title: "colSums"
subtitle: "colSums"
---

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

## Usage

```r
colSums(x, na.rm = FALSE, dims = 1L, ...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An \code{HDF5Matrix} object. |
| `na.rm` | Ignored (included for compatibility with the base generic). |
| `dims` | Ignored (included for compatibility with the base generic). |
| `paral` | Logical or NULL. Enable OpenMP parallelisation. |
| `wsize` | Integer or NULL. Block size for HDF5 reads (NULL = auto). |
| `threads` | Integer or NULL. Number of OpenMP threads (NULL = auto). |
| `save_to` | Where to save the result (see Details).  NULL returns a                 plain R vector; a character string \code{"group/dataset"}                 saves in the same file as \code{x}; a named list                 \code{list(file = "f.h5", path = "group/dataset")} saves in                 a different file.  In both non-NULL cases an                 \code{HDF5Matrix} handle is returned. |
| `overwrite` | Logical.  Overwrite an existing dataset at \code{save_to}?                 (Currently always TRUE when \code{save_to} is not NULL.) |
:::

## Value

::: {.return-value}
A numeric vector (when \code{save_to = NULL}) or an
  \code{HDF5Matrix} handle to the persisted result.

:::
## Examples
```{r}
#| eval: false
#| warning: false

\donttest{
tmp <- tempfile(fileext = ".h5")
X <- hdf5_create_matrix(tmp, "data/M", data = matrix(rnorm(200), 20, 10))
cs <- colSums(X)         # R vector
hdf5_close_all()
unlink(tmp)
}

```