is_open

HDF5MATRIX_CORE

1 Description

Check whether an HDF5Matrix object is still valid and open.

2 Usage

is_open(x)

3 Arguments

Parameter	Description
`x`	An object

4 Value

Logical. if object is valid and open, otherwise.

5 Examples

\donttest{
tmp <- tempfile(fileext = ".h5")

X  <- hdf5_create_matrix(tmp, "data/matrix", data = matrix(rnorm(100), 10, 10))

X <- hdf5_matrix(tmp, "data/matrix")
is_open(X)  # TRUE

close(X)
is_open(X)  # FALSE

unlink(tmp)
}

---
title: "is_open"
subtitle: "is_open"
---

<span class="category-badge hdf5matrix_core">HDF5MATRIX_CORE</span>

## Description

Check whether an HDF5Matrix object is still valid and open.

## Usage

```r
is_open(x)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `x` | An \code{HDF5Matrix} object  |
:::

## Value

::: {.return-value}
Logical. \code{TRUE} if object is valid and open, \code{FALSE} otherwise.

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

\donttest{
tmp <- tempfile(fileext = ".h5")

X  <- hdf5_create_matrix(tmp, "data/matrix", data = matrix(rnorm(100), 10, 10))

X <- hdf5_matrix(tmp, "data/matrix")
is_open(X)  # TRUE

close(X)
is_open(X)  # FALSE

unlink(tmp)
}

```