GetRegUserDataFromH5: Reads entries from a registered data source dataset.

View source: R/RcppExports.R

GetRegUserDataFromH5R Documentation

Reads entries from a registered data source dataset.

Description

GetRegUserDataFromH5 reads an entry (or all entries) from a registered data source dataset (created by RegisterUserData... functions).

Usage

GetRegUserDataFromH5(
  Filename,
  location,
  bufIndex,
  writeIndex,
  readDescription = TRUE
)

Arguments

Filename

Path/filename of the HDF5 file.

location

Location of the group or dataset where the attribute is attached to.

bufIndex

Buf index.

writeIndex

Write index.

readDescription

If TRUE (default) the data descripton is read, if false the data description is not read.

Details

If bufIndex = writeIndex = -1, all data are read.

Value

A list containing the registered user data and description, or a numeric vector containing the data only if readDescription = FALSE.

Examples

## Not run: 
GetRegUserDataFromH5("path/to/file.h5", location = )

## End(Not run)

pasturm/TofDaqR documentation built on March 29, 2024, 12:10 a.m.