rcpp_hdf5_remove_dataset: Remove (unlink) a dataset from an HDF5 file (R6 wrapper)

In BigDataStatMeth: Scalable Statistical Computing with HDF5-Backed Matrices

Remove (unlink) a dataset from an HDF5 file (R6 wrapper)

Description

Opens a dataset by (filename, group, dataset) and unlinks it from the HDF5 file. Backs the R-level hdf5_remove function and the HDF5Matrix$remove() method.

Usage

rcpp_hdf5_remove_dataset(filename, group, dataset)

Arguments

filename	Path to the HDF5 file.
group	Group path containing the dataset (e.g. "data").
dataset	Dataset name within the group (e.g. "matrix").

Details

openDataset() both opens the file handle required by hdf5Dataset::remove() and validates that the dataset actually exists, throwing if it does not. HDF5 then only removes the link to the dataset — the disk space it occupied is NOT reclaimed until the file is rewritten (e.g. with h5repack). See hdf5_remove for the user-facing caveat.

Value

TRUE on success.

BigDataStatMeth documentation built on Sept. 15, 2026, 1:08 a.m.