HDF5 File Interface: HDF5 File Interface

Description

These functions are designed to provide file-level access to HDF5 files.

Usage

H5Fcreate      (name, flags = h5default("H5F_ACC"))
H5Fopen        (name, flags = h5default("H5F_ACC_RD"))
H5Fclose       (h5file)
H5Fflush       (h5file, scope = h5default("H5F_SCOPE"))
H5Fis_hdf5     (name, showWarnings = TRUE)
H5Fget_filesize(h5file)
H5Fget_name    (h5obj)

Arguments

name

The filename of the HDF5 file.

flags

See h5const("H5F_ACC") for possible arguments.

h5file

An object of class H5IdComponent representing a H5 file identifier as created by H5Fcreate or H5Fopen.

scope

See h5const("H5F_ACC_RD") for possible arguments.

showWarnings

If TRUE (default), a warning is given if an open HDF5 handle exists for this file.

h5obj

An object of class H5IdComponent representing a H5 object identifier (file, group, or dataset). See H5Fcreate, H5Fopen, H5Gcreate, H5Gopen, H5Dcreate, or H5Dopen to create an object of this kind.

Value

H5Fcreate and H5Fopen return an object of class H5IdComponent representing a H5 file identifier.H5Fis_hdf5 returns TRUE, if the file is an HDF5 file, or FALSE otherwise. In the case the file doesn't exist, NA is returned.The other functions return the standard return value from their respective C-functions.

Details

Interface to the HDF5 C-library libhdf5. See http://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html for further details.

References

http://www.hdfgroup.org/HDF5

Examples

Run this code

fid <- H5Fcreate("ex_H5F.h5")
fid
H5Fclose(fid)
fid2 <- H5Fopen("ex_H5F.h5")
fid2
H5Fclose(fid2)

Run the code above in your browser using DataLab