rcpp_hdf5dataset_read_dimnames

OTHER

1 Description

Reads the row and column names stored alongside an HDF5 dataset following the BigDataStatMeth convention: When a component has not been written an empty character(0) is returned for it. The function uses BigDataStatMeth::hdf5Dims in read mode (bWrite = false) so no data on disk is modified.

2 Usage

rcpp_hdf5dataset_read_dimnames(ptr_sexp)

3 Arguments

Parameter	Description
`ptr_sexp`	External pointer (SEXP) to an open object managed by the R6 class.

4 Value

Named list with two elements:

rownames: Row names, or \code{character(0)
colnames: Column names, or \code{character(0)

---
title: "rcpp_hdf5dataset_read_dimnames"
subtitle: "rcpp_hdf5dataset_read_dimnames"
---

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

## Description

Reads the row and column names stored alongside an HDF5 dataset following
the BigDataStatMeth convention:
\itemize{
  \item rownames stored at `group/.<dataset>_dimnames/1`
  \item colnames stored at `group/.<dataset>_dimnames/2`
}
When a component has not been written an empty `character(0)` is
returned for it.  The function uses `BigDataStatMeth::hdf5Dims` in
read mode (`bWrite = false`) so no data on disk is modified.

## Usage

```r
rcpp_hdf5dataset_read_dimnames(ptr_sexp)
```
## Arguments

::: {.param-table}
| Parameter | Description |
|-----------|-------------|
| `ptr_sexp` | External pointer (SEXP) to an open \code{hdf5Dataset}   object managed by the R6 class.  |
:::

## Value

::: {.return-value}
Named list with two \code{character} elements:


- **`rownames`**: Row names, or \code{character(0)
- **`colnames`**: Column names, or \code{character(0)

:::