bdCreate_hdf5_group

HDF5_IO_MANAGEMENT

1 Description

Create a (nested) group inside an HDF5 file. The operation is idempotent: if the group already exists, no error is raised.

2 Usage

bdCreate_hdf5_group(filename, group)

3 Arguments

Parameter	Description
`filename`	Character string. Path to the HDF5 file.
`group`	Character string. Group path to create (e.g., `"MGCCA_OUT/scores"`).

4 Value

List with components:

fn: Character string with the HDF5 filename
gr: Character string with the full group path created within the HDF5 file

5 Details

Intermediate groups are created when needed. The HDF5 file must exist prior to the call (create it with a writer function).

6 Examples

\donttest{
fn <- tempfile(fileext = ".h5")
hdf5_create_matrix(fn, "tmp/seed", data = matrix(0, 1, 1))
bdCreate_hdf5_group(fn, "MGCCA_OUT/scores")
hdf5_close_all()
unlink(fn)
}

7 See Also

hdf5_create_matrix.

---
title: "bdCreate_hdf5_group"
subtitle: "bdCreate_hdf5_group"
---

<span class="category-badge hdf5_io_management">HDF5_IO_MANAGEMENT</span>

## Description

Create a (nested) group inside an HDF5 file. The operation is
idempotent: if the group already exists, no error is raised.

## Usage

```r
bdCreate_hdf5_group(filename, group)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `filename` | Character string. Path to the HDF5 file. |
| `group` | Character string. Group path to create   (e.g., `"MGCCA_OUT/scores"`).  |
:::

## Value

::: {.return-value}
List with components:


- **`fn`**: Character string with the HDF5 filename
- **`gr`**: Character string with the full group path created within the 
  HDF5 file

:::
## Details

Intermediate groups are created when needed. The HDF5 file must
exist prior to the call (create it with a writer function).

## Examples
```{r}
#| eval: false
#| warning: false

\donttest{
fn <- tempfile(fileext = ".h5")
hdf5_create_matrix(fn, "tmp/seed", data = matrix(0, 1, 1))
bdCreate_hdf5_group(fn, "MGCCA_OUT/scores")
hdf5_close_all()
unlink(fn)
}

```
## See Also

::: {.see-also}
[hdf5_create_matrix](../hdf5matrix_core/hdf5_create_matrix.html).

:::