HDF5 File Interface {rhdf5} | R Documentation

## HDF5 File Interface

### Description

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

### Usage

    H5Fcreate           (name, flags = h5default("H5F_ACC"), fcpl = NULL,
                         fapl = NULL, native = FALSE)
    H5Fopen             (name, flags = h5default("H5F_ACC_RD"), native = FALSE)
    H5Fclose            (h5file)
    H5Fflush            (h5file, scope = h5default("H5F_SCOPE"))
    H5Fis_hdf5          (name, showWarnings = TRUE)
    H5Fget_filesize     (h5file)
    H5Fget_name         (h5obj)
    H5Fget_create_plist (h5file)
    H5Fget_access_plist (h5file)

### Arguments

`name` | The filename of the HDF5 file.
`flags` | See `h5const("H5F_ACC")` for possible arguments.
`fcpl` | An object of class `H5IdComponent` representing a H5 file creation property list. See `H5Pcreate`, `H5Pcopy` to create an object of this kind.
`fapl` | An object of class `H5IdComponent` representing a H5 file access property list. See `H5Pcreate`, `H5Pcopy` to create an object of this kind.
`native` | An object of class `logical`. If TRUE, array-like objects are treated as stored in HDF5 row-major rather than R column-major orientation. Using `native = TRUE` increases HDF5 file portability between programming languages. A file written with `native = TRUE` should also be read with `native = TRUE`

.

`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.

### Details

Interface to the HDF5 C-library libhdf5. See https://portal.hdfgroup.org/display/HDF5/Files for further details.

### 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.

### Author(s)

Bernd Fischer

### References

https://portal.hdfgroup.org/display/HDF5

### See Also

rhdf5

### Examples

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

[Package rhdf5 version 2.28.1 Index]