dimnames.HDF5Matrix

OTHER

1 Description

Returns the row and column names stored alongside the HDF5 dataset, following the BigDataStatMeth convention. Returns NULL when no names have been stored for a given dimension.

2 Usage

dimnames.HDF5Matrix(x)

3 Arguments

Parameter	Description
`x`	An object

4 Value

A list of length 2 with elements (rownames) and (colnames), or for dimensions without names. Returns when neither dimension has names.

5 Examples

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

m <- matrix(1:6, 2, 3,
            dimnames = list(c("r1","r2"), c("c1","c2","c3")))

X <- hdf5_create_matrix(tmp, "data/mat", data = m)

dimnames(X)
rownames(X)
colnames(X)
rownames(X) <- c("row1", "row2")
rownames(X)
hdf5_close_all()
unlink(tmp)

}

---
title: "dimnames.HDF5Matrix"
subtitle: "dimnames.HDF5Matrix"
---

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

## Description

Returns the row and column names stored alongside the HDF5 dataset,
following the BigDataStatMeth convention. Returns `NULL` when no
names have been stored for a given dimension.

## Usage

```r
dimnames.HDF5Matrix(x)
```
## Arguments

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

## Value

::: {.return-value}
A list of length 2 with elements \code{[[1]]} (rownames) and
  \code{[[2]]} (colnames), or \code{NULL} for dimensions without names.
  Returns \code{NULL} when neither dimension has names.

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

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

m <- matrix(1:6, 2, 3,
            dimnames = list(c("r1","r2"), c("c1","c2","c3")))

X <- hdf5_create_matrix(tmp, "data/mat", data = m)

dimnames(X)
rownames(X)
colnames(X)
rownames(X) <- c("row1", "row2")
rownames(X)
hdf5_close_all()
unlink(tmp)

}

```