% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/S3_bind.R
\name{rbind.HDF5Matrix}
\alias{rbind.HDF5Matrix}
\title{Row-bind HDF5Matrix objects}
\usage{
\method{rbind}{HDF5Matrix}(
  ...,
  deparse.level = 1,
  out_file = NULL,
  out_group = NULL,
  out_dataset = NULL,
  block_rows = 1000L,
  overwrite = FALSE,
  compression = NULL
)
}
\arguments{
\item{...}{One or more \code{HDF5Matrix} objects (all with the
same number of columns).}

\item{deparse.level}{Ignored (for S3 compatibility with base::rbind).}

\item{out_file}{Output HDF5 file. \code{NULL} = same file as first argument.}

\item{out_group}{Output group.   \code{NULL} = \code{"BIND"}.}

\item{out_dataset}{Output dataset name. \code{NULL} = auto-generated:
for two inputs the name is \code{"A_rbind_B"}; for three or more inputs
it is \code{"rbind_N"} where \code{N} is the number of inputs, to
prevent unbounded name growth.}

\item{block_rows}{Integer. Rows per I/O block (default 1000).}

\item{overwrite}{Logical. Overwrite existing output. Default \code{FALSE}.}

\item{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{
\code{HDF5Matrix} pointing to the combined dataset.
}
\description{
Binds two or more \code{HDF5Matrix} objects by rows (appending rows
below). All matrices must have the same number of columns. The
operation is performed block-wise on disk.
}
\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)

}

}
