rbind.HDF5Matrix

rbind.HDF5Matrix

OTHER

1 Description

Binds two or more HDF5Matrix objects by rows (appending rows below). All matrices must have the same number of columns. The operation is performed block-wise on disk.

2 Usage

rbind.HDF5Matrix(...)

3 Arguments

Parameter	Description
`deparse.level`	Ignored (for S3 compatibility with base::rbind).
`out_file`	Output HDF5 file. = same file as first argument.
`out_group`	Output group. = .
`out_dataset`	Output dataset. = auto-generated name.
`block_rows`	Integer. Rows per I/O block (default 1000).
`overwrite`	Logical. Overwrite existing output. Default .
`compression`	Integer (0-9) or NULL. gzip compression level for the result datasets. NULL uses the global option set by (default 6). Use to disable compression (faster for benchmarks).

4 Value

pointing to the combined dataset.

5 Examples

\donttest{

fn <- tempfile(fileext = ".h5")

A  <- hdf5_create_matrix(fn, "grp/A", data = matrix(rnorm(100), 10, 10))
B  <- hdf5_create_matrix(fn, "grp/B", data = matrix(rnorm(100), 10, 10))

A <- hdf5_matrix(fn, "grp/A")
B <- hdf5_matrix(fn, "grp/B")
C <- rbind(A, B)          # rows of A followed by rows of B
dim(C)                    # (nrow(A) + nrow(B)) x ncol(A)

hdf5_close_all()
unlink(fn)

}

---
title: "rbind.HDF5Matrix"
subtitle: "rbind.HDF5Matrix"
---

<span class="category-badge other">OTHER</span>

## Description

Binds two or more `HDF5Matrix` objects by rows (appending rows
below). All matrices must have the same number of columns. The
operation is performed block-wise on disk.

## Usage

```r
rbind.HDF5Matrix(...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `deparse.level` | Ignored (for S3 compatibility with base::rbind). |
| `out_file` | Output HDF5 file. \code{NULL} = same file as first argument. |
| `out_group` | Output group.   \code{NULL} = \code{"BIND"}. |
| `out_dataset` | Output dataset. \code{NULL} = auto-generated name. |
| `block_rows` | Integer. Rows per I/O block (default 1000). |
| `overwrite` | Logical. Overwrite existing output. Default \code{FALSE}. |
| `compression` | Integer (0-9) or NULL. gzip compression level for the   result datasets.  NULL uses the global option set by   \code{\link{hdf5matrix_options}} (default 6).  Use \code{0} to disable   compression (faster for benchmarks). |
:::

## Value

::: {.return-value}
\code{HDF5Matrix} pointing to the combined dataset.

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

\donttest{

fn <- tempfile(fileext = ".h5")

A  <- hdf5_create_matrix(fn, "grp/A", data = matrix(rnorm(100), 10, 10))
B  <- hdf5_create_matrix(fn, "grp/B", data = matrix(rnorm(100), 10, 10))

A <- hdf5_matrix(fn, "grp/A")
B <- hdf5_matrix(fn, "grp/B")
C <- rbind(A, B)          # rows of A followed by rows of B
dim(C)                    # (nrow(A) + nrow(B)) x ncol(A)

hdf5_close_all()
unlink(fn)

}

```