% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RcppExports.R
\name{rcpp_hdf5dataset_read_dimnames}
\alias{rcpp_hdf5dataset_read_dimnames}
\title{Read dimension names (rownames / colnames) from an HDF5 dataset}
\usage{
rcpp_hdf5dataset_read_dimnames(ptr_sexp)
}
\arguments{
\item{ptr_sexp}{External pointer (SEXP) to an open \code{hdf5Dataset}
object managed by the R6 class.}
}
\value{
Named list with two \code{character} elements:
\describe{
\item{rownames}{Row names, or \code{character(0)} if absent}
\item{colnames}{Column names, or \code{character(0)} if absent}
}
}
\description{
Reads the row and column names stored alongside an HDF5 dataset following
the BigDataStatMeth convention:
\itemize{
\item rownames stored at \code{group/.<dataset>_dimnames/1}
\item colnames stored at \code{group/.<dataset>_dimnames/2}
}
When a component has not been written an empty \code{character(0)} is
returned for it.  The function uses \code{BigDataStatMeth::hdf5Dims} in
read mode (\code{bWrite = false}) so no data on disk is modified.
}
\keyword{internal}
