write_hdf5: Write a matrix to an HDF5 file

In delarr: Lazy Delayed Arrays with Fused Execution

Write a matrix to an HDF5 file

Description

Simple convenience function to write a matrix to an HDF5 dataset. For streaming writes during collect(), use hdf5_writer() instead.

Usage

write_hdf5(x, path, dataset, compression = 4L)

Arguments

x	A matrix to write.
path	Path to the HDF5 file. Created if it doesn't exist.
dataset	Name of the dataset to create.
compression	Gzip compression level (0-9), or NULL for no compression.

Value

The path to the HDF5 file (invisibly).

Examples

if (requireNamespace("hdf5r", quietly = TRUE)) {
  # Write a matrix to HDF5
  mat <- matrix(1:20, nrow = 4, ncol = 5)
  tf <- tempfile(fileext = ".h5")
  write_hdf5(mat, tf, "X")

  # Read it back as a delarr
  darr <- delarr_hdf5(tf, "X")
  collect(darr)

  # Clean up
  unlink(tf)
}

delarr documentation built on July 1, 2026, 1:06 a.m.