getObjectNamesHDF5: Get names of HDF5 objects from HDF5 file and name.

Description Usage Arguments Value

View source: R/hdf5.R

Description

Get names of HDF5 objects from HDF5 file and name.

Usage

1
2
getObjectNamesHDF5(infile, h5name = NULL, relative = FALSE, min.depth = 0,
  max.depth = NULL)

Arguments

infile

An input HDF5 file.

h5name

Name of HDF5 object to use as a starting-point. By default, results are returned with respect to the HDF5 root object.

relative

Option indicating that the returned HDF5 object names should be given relative to the starting-point. By default, absolute HDF5 object names are returned.

min.depth

Minimum recursion depth (relative to starting-point) from which to return object names. If not specified, no minimum depth constraint is applied, and the results include the starting-point HDF5 object (if all other constraints are satisfied).

max.depth

Maximum recursion depth (relative to starting-point) from which to return object names. If not specified, no maximum depth constraint is applied, and the results include every HDF5 object below the starting-point (for which all other constraints are satisfied).

Value

Character vector of names of HDF5 objects that lie within the section of the HDF5 file defined by the starting-point HDF5 object and any specified constraints.


gact/shmootl documentation built on Nov. 11, 2021, 6:23 p.m.