as.data.frame.HDF5Matrix

OTHER

1 Description

Reads entire HDF5 dataset into memory as a data.frame. WARNING: This loads all data into RAM.

2 Usage

as.data.frame.HDF5Matrix(...)

3 Arguments

Parameter	Description
`x`	An object
`force`	Logical. If , skip size warnings.
`max_size_mb`	Numeric. Maximum size in MB to convert without warning.
`row.names`	Logical or character vector. Row names to use.
`optional`	Logical. Passed to .

4 Value

data.frame with data from HDF5 file

5 Details

First converts to matrix using as.matrix.HDF5Matrix (with same size checks), then to data.frame. All memory warnings apply.

6 Examples

\donttest{
    fn <- tempfile(fileext = ".h5")
    X <- hdf5_create_matrix(fn, "data/X", data = matrix(rnorm(500), 100, 5))
    df <- as.data.frame(X)
    hdf5_close_all()
    unlink(fn)
}

7 See Also

as.matrix.HDF5Matrix

---
title: "as.data.frame.HDF5Matrix"
subtitle: "as.data.frame.HDF5Matrix"
---

<span class="category-badge other">OTHER</span>

## Description

Reads entire HDF5 dataset into memory as a data.frame.
**WARNING**: This loads all data into RAM.

## Usage

```r
as.data.frame.HDF5Matrix(...)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An \code{HDF5Matrix} object |
| `force` | Logical. If \code{TRUE}, skip size warnings. |
| `max_size_mb` | Numeric. Maximum size in MB to convert without warning. |
| `row.names` | Logical or character vector. Row names to use. |
| `optional` | Logical. Passed to \code{as.data.frame}. |
:::

## Value

::: {.return-value}
data.frame with data from HDF5 file

:::
## Details

First converts to matrix using `as.matrix.HDF5Matrix` (with same
size checks), then to data.frame. All memory warnings apply.

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

\donttest{
    fn <- tempfile(fileext = ".h5")
    X <- hdf5_create_matrix(fn, "data/X", data = matrix(rnorm(500), 100, 5))
    df <- as.data.frame(X)
    hdf5_close_all()
    unlink(fn)
}

```
## See Also

::: {.see-also}
[as.matrix.HDF5Matrix](as.matrix.HDF5Matrix.html)

:::