h5Delete {hdf5r.Extra}

Delete an HDF5 link

Description

Delete an HDF5 link

Usage

h5Delete(x, name, ...)

## S3 method for class 'H5Group'
h5Delete(x, name, verbose = TRUE, ...)

## S3 method for class 'H5File'
h5Delete(x, name, verbose = TRUE, ...)

## S3 method for class 'character'
h5Delete(x, name, verbose = TRUE, ...)

Arguments

x

An existing HDF5 file

name

Name of HDF5 link to be deleted. If name doesn't exist, nothing will be done.

...

Arguments passed to H5Group$link_delete()

verbose

Print progress.

Value

This is an operation function and no return. Any failure should raise an error.

Examples

file <- system.file("extdata", "pbmc_small.h5ad", package = "hdf5r.Extra")
to.file <- tempfile(fileext = ".h5")
file.copy(file, to.file)

h5Delete(to.file, "obs")
h5Delete(to.file, "xxxx") # Delete something not existing.