bdCreate_hdf5_emptyDataset

bdCreate_hdf5_emptyDataset

HDF5_IO_MANAGEMENT

1 Description

Creates an HDF5 dataset of size nrows × ncols inside group with name dataset, without writing data (allocation only). Honors file/dataset overwrite flags and supports unlimited datasets.

2 Usage

bdCreate_hdf5_emptyDataset(filename, group, dataset, nrows = 0L, ncols = 0L, overwriteFile = NULL, overwriteDataset = NULL, unlimited = NULL, datatype = NULL)

3 Arguments

Parameter	Description
`filename`	Character. Path to the HDF5 file.
`group`	Character. Group path.
`dataset`	Character. Dataset name.
`nrows`	Integer (>= 1). Number of rows.
`ncols`	Integer (>= 1). Number of columns.
`overwriteFile`	Logical. If , allow file recreate default value .
`overwriteDataset`	Logical. If , replace dataset default value .
`unlimited`	Logical. If , create unlimited dataset default value .
`datatype`	Character. Element type (e.g., “real”).

4 Value

List with components:

fn: Character string with the HDF5 filename
ds: Character string with the full dataset path to the empty dataset (group/dataset)

5 Examples

Code

bdCreate_hdf5_emptyDataset("test.h5", "MGCCA_IN", "X", 1000, 500,
                          overwriteFile = FALSE,
                          overwriteDataset = TRUE,
                          unlimited = FALSE,
                          datatype = "real")

---
title: "bdCreate_hdf5_emptyDataset"
subtitle: "bdCreate_hdf5_emptyDataset"
---

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

## Description

Creates an HDF5 dataset of size `nrows × ncols` inside `group`
with name `dataset`, without writing data (allocation only).
Honors file/dataset overwrite flags and supports unlimited datasets.

## Usage

```r
bdCreate_hdf5_emptyDataset(filename, group, dataset, nrows = 0L, ncols = 0L, overwriteFile = NULL, overwriteDataset = NULL, unlimited = NULL, datatype = NULL)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `filename` | Character. Path to the HDF5 file. |
| `group` | Character. Group path. |
| `dataset` | Character. Dataset name. |
| `nrows` | Integer (>= 1). Number of rows. |
| `ncols` | Integer (>= 1). Number of columns. |
| `overwriteFile` | Logical. If \code{TRUE}, allow file recreate  default value \code{FALSE}. |
| `overwriteDataset` | Logical. If \code{TRUE}, replace dataset  default value \code{FALSE}. |
| `unlimited` | Logical. If \code{TRUE}, create unlimited dataset  default value \code{FALSE}. |
| `datatype` | Character. Element type (e.g., "real").  |
:::

## Value

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


- **`fn`**: Character string with the HDF5 filename
- **`ds`**: Character string with the full dataset path to the empty 
  dataset (group/dataset)

:::

## Examples

```{r}
#| eval: false
#| code-fold: show

bdCreate_hdf5_emptyDataset("test.h5", "MGCCA_IN", "X", 1000, 500,
                          overwriteFile = FALSE,
                          overwriteDataset = TRUE,
                          unlimited = FALSE,
                          datatype = "real")
```