H5Group_access: Retrieve object from a group of file

In hdf5r: Interface to the 'HDF5' Binary Data Format

Retrieve object from a group of file

Description

Retrieve object from a group of file

Usage

## S3 method for class 'H5Group'
x[[name, ..., link_access_pl = h5const$H5P_DEFAULT,
  dataset_access_pl = h5const$H5P_DEFAULT,
  type_access_pl = h5const$H5P_DEFAULT]]

## S3 method for class 'H5File'
x[[name, ..., link_access_pl = h5const$H5P_DEFAULT,
  dataset_access_pl = h5const$H5P_DEFAULT,
  type_access_pl = h5const$H5P_DEFAULT]]

## S3 replacement method for class 'H5Group'
x[[name, ...]] <- value

## S3 replacement method for class 'H5File'
x[[name, ...]] <- value

Arguments

x	An object of class H5File or H5Group
name	Name of the object to retrieve. Has to be a character vector of length one. No integer values allowed.
...	Currently ignored
link_access_pl	An object of class H5P_LINK_ACCESS.
dataset_access_pl	An object of class H5P_DATASET_ACCESS.
type_access_pl	Currently always h5const$H5P_DEFAULT
value	What to assign. Has to be one of H5Group, H5D or H5T

Details

Works similar to retrieving objects in a list. x[["my_name"]] retrieves object my_name from the HDF5-File or HDF5-Group x.

One can also assign objects under a not yet existing name. For either a H5Group or H5D, a hard link is created. If it is a datatype, H5T, this is committed under the chosen name name.

Value

A H5Group, H5D or H5T, depending on the object saved in the group under the requested name.

Author(s)

Holger Hoefling

hdf5r documentation built on Jan. 22, 2023, 1:12 a.m.