h5 (version 0.9.1)

H5File: The H5File Class

Description

Representation of an HDF5 file which can be either created or accessed if existing. In addition to File--specific capabilities listed below H5File shares common functionality with H5Group through the CommonFG base class.

Usage

H5File(name, mode = "a")
h5flush(.Object)
## S3 method for class 'H5File':
h5flush(.Object)
## S3 method for class 'H5File':
h5close(.Object)

Arguments

name

character; File path pointing to H5File.

mode

mode used for file. The following modes are supported by H5File: [object Object],[object Object],[object Object],[object Object],[object Object]

.Object

H5File; S4 object of class H5File;

Details

HDF5 files can be opened or generated using the H5File() function and a specified file access mode. H5File() returns a H5File object which can be used to access H5Groups and DataSets using subsetting parameters or functions accordingly.

HDF5 files which have been created or opened through H5File() need to be closed afterwards using h5close().

h5flush() can be used to flush unwritten data to an HDF5 file.

See Also

CommonFG CommonFG-Group CommonFG-DataSet H5Location-Attribute

Examples

# Create new file using mode 'a'
file <- H5File("test.h5")
h5close(file)
# Open File for read-only
file <- H5File("test.h5", "r")
h5close(file)
file.remove("test.h5")