bdCreate_hdf5_matrix

HDF5_IO_MANAGEMENT

1 Usage

bdCreate_hdf5_matrix(filename, object, group = NULL, dataset = NULL, transp = NULL, overwriteFile = NULL, overwriteDataset = NULL, unlimited = NULL)

2 Arguments

Parameter	Description
`object`	numerical data matrix
`transp`	boolean, if trans=true matrix is stored transposed in HDF5 file

3 Value

List with components:

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

4 Examples

\donttest{
    fn <- tempfile(fileext = ".h5")
    matA <- matrix(c(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15), nrow = 3, byrow = TRUE)
    bdCreate_hdf5_matrix(filename = fn,
                         object = matA, group = "datasets",
                         dataset = "datasetA", transp = FALSE,
                         overwriteFile = TRUE,
                         overwriteDataset = TRUE,
                         unlimited = FALSE)
    hdf5_close_all()
    unlink(fn)
}

---
title: "bdCreate_hdf5_matrix"
subtitle: "bdCreate_hdf5_matrix"
---

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

## Usage

```r
bdCreate_hdf5_matrix(filename, object, group = NULL, dataset = NULL, transp = NULL, overwriteFile = NULL, overwriteDataset = NULL, unlimited = NULL)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `object` | numerical data matrix |
| `transp` | boolean, if trans=true matrix is stored transposed in HDF5 file |
:::

## Value

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


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

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

\donttest{
    fn <- tempfile(fileext = ".h5")
    matA <- matrix(c(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15), nrow = 3, byrow = TRUE)
    bdCreate_hdf5_matrix(filename = fn,
                         object = matA, group = "datasets",
                         dataset = "datasetA", transp = FALSE,
                         overwriteFile = TRUE,
                         overwriteDataset = TRUE,
                         unlimited = FALSE)
    hdf5_close_all()
    unlink(fn)
}

```