bdWrite_hdf5_dimnames

bdWrite_hdf5_dimnames

HDF5_IO_MANAGEMENT

1 Description

Write row and/or column names metadata for an existing dataset in an HDF5 file. Empty vectors skip the corresponding dimnames.

2 Usage

bdWrite_hdf5_dimnames(filename, group, dataset, rownames, colnames)

3 Arguments

Parameter Description
filename Character string. Path to the HDF5 file.
group Character string. Group containing the dataset.
dataset Character string. Dataset name inside .
rownames Character vector of row names. Use to skip writing row names. If provided, length must equal nrow.
colnames Character vector of column names. Use to skip writing column names. If provided, length must equal ncol.

4 Value

List with components. If an error occurs, all string values are returned as empty strings (““):

  • fn: Character string with the HDF5 filename
  • dsrows: Character string with the full dataset path to the row names, stored as “.\code{dataset
  • dscols: Character string with the full dataset path to the column names, stored as “.\code{dataset

5 Details

The dataset group/dataset must already exist. When non-empty, rownames and colnames lengths are validated against the dataset dimensions.

6 Examples

\donttest{
fn <- tempfile(fileext = ".h5")
hdf5_create_matrix(fn, "MGCCA_IN/X",
                   data = matrix(rnorm(5000), 100, 50))

bdWrite_hdf5_dimnames(
  filename = fn,
  group    = "MGCCA_IN",
  dataset  = "X",
  rownames = paste0("r", seq_len(100)),
  colnames = paste0("c", seq_len(50))
)
hdf5_close_all()
unlink(fn)
}