# Interface to the 'HDF5' Binary Data Format

## Documentation for package ‘hdf5r’ version 1.3.12

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A C D E F G H I L N O P R S T V misc

hdf5r-package | hdf5r: A package to provide an interface to hdf5 from R

## -- A --

as.character.factor_ext | Various functions for 'factor_ext' objects
as.data.frame.H5R | Various functions for 'H5R' objects
as.vector.H5R | Various functions for 'H5R' objects
as_hex | Convert a double or integer to hex

## -- C --

c.factor_ext | Various functions for 'factor_ext' objects
c.H5D | Wrapper functions to provide an 'h5' compatible interface.
c.H5R | Various functions for 'H5R' objects
cbind.H5D | Wrapper functions to provide an 'h5' compatible interface.
cbind.H5R | Various functions for 'H5R' objects
coerce_to_factor | Various functions for 'factor_ext' objects
coercible_to_factor | Various functions for 'factor_ext' objects
createDataSet | Wrapper functions to provide an 'h5' compatible interface.
createGroup | Wrapper functions to provide an 'h5' compatible interface.
create_empty | Create an empty R-object according to a given HDF5 datatype

## -- D --

dim.H5R | Various functions for 'H5R' objects
dim<-.H5R | Various functions for 'H5R' objects
dimnames.H5R | Various functions for 'H5R' objects
dimnames<-.H5R | Various functions for 'H5R' objects

## -- E --

existsGroup | Wrapper functions to provide an 'h5' compatible interface.
extendDataSet | Wrapper functions to provide an 'h5' compatible interface.

## -- F --

factor_ext | Create an extended factor
factor_ext_functions | Various functions for 'factor_ext' objects
flatten_df | Flatten a nested data.frame
format.H5R | Various functions for 'H5R' objects

## -- G --

guess_chunks | Guess the dimension of a chunk
guess_dim | Guess the HDF5 datatype of an R object
guess_dtype | Guess the HDF5 datatype of an R object
guess_nelem | Guess the HDF5 datatype of an R object
guess_space | Guess the dataspace of an object

## -- H --

h5 | Wrapper functions to provide an 'h5' compatible interface.
h5-wrapper | Wrapper functions to provide an 'h5' compatible interface.
H5A | Class for representing HDF5 attributes
H5A-class | Class for representing HDF5 attributes
h5attr | Interface for HDF5 attributes
h5attr<- | Interface for HDF5 attributes
h5attributes | Interface for HDF5 attributes
h5attr_names | Interface for HDF5 attributes
h5close | Wrapper functions to provide an 'h5' compatible interface.
h5const | All constants used in HDF5
H5D | Class for representing HDF5 datasets
H5D-class | Class for representing HDF5 datasets
H5File | Class for interacting with HDF5 files.
h5file | Wrapper functions to provide an 'h5' compatible interface.
H5File-class | Class for interacting with HDF5 files.
h5flush | Wrapper functions to provide an 'h5' compatible interface.
h5garbage_collect | Trigger the HDF5 garbage collection
H5Group | Class for representing HDF5 groups
H5Group-class | Class for representing HDF5 groups
H5Group_access | Retrieve object from a group of file
H5P | Class for HDF5 property lists.
H5P-class | Class for HDF5 property lists.
H5P_ATTRIBUTE_CREATE | Class for HDF5 property list for attribute creation
H5P_ATTRIBUTE_CREATE-class | Class for HDF5 property list for attribute creation
H5P_CLASS | Class for HDF5 property list classes (not HDF5 property lists)
H5P_CLASS-class | Class for HDF5 property list classes (not HDF5 property lists)
H5P_DATASET_ACCESS | Class for HDF5 property list for dataset access
H5P_DATASET_ACCESS-class | Class for HDF5 property list for dataset access
H5P_DATASET_CREATE | Class for HDF5 property list for dataset creation
H5P_DATASET_CREATE-class | Class for HDF5 property list for dataset creation
H5P_DATASET_XFER | Class for HDF5 property list for dataset transfer
H5P_DATASET_XFER-class | Class for HDF5 property list for dataset transfer
H5P_FILE_ACCESS | Class for HDF5 property list for file creation
H5P_FILE_ACCESS-class | Class for HDF5 property list for file creation
H5P_FILE_CREATE | Class for HDF5 property list for file creation
H5P_FILE_CREATE-class | Class for HDF5 property list for file creation
H5P_LINK_ACCESS | Class for HDF5 property list for link access
H5P_LINK_ACCESS-class | Class for HDF5 property list for link access
H5P_LINK_CREATE | Class for HDF5 property list for link creation
H5P_LINK_CREATE-class | Class for HDF5 property list for link creation
H5P_OBJECT_COPY | Class for HDF5 property list for object copying
H5P_OBJECT_COPY-class | Class for HDF5 property list for object copying
H5P_OBJECT_CREATE | Class for HDF5 property list for object creation
H5P_OBJECT_CREATE-class | Class for HDF5 property list for object creation
H5R | Class for HDF5 Reference datatypes.
H5R-class | Class for HDF5 Reference datatypes.
H5RefClass | Base class that tracks the ids and allows for closing an id
H5RefClass-class | Base class that tracks the ids and allows for closing an id
H5R_DATASET_REGION | Class for HDF5 dataset-region references.
H5R_DATASET_REGION-class | Class for HDF5 dataset-region references.
H5R_functions | Various functions for 'H5R' objects
H5R_OBJECT | Class for HDF5 Object-references.
H5R_OBJECT-class | Class for HDF5 Object-references.
H5S | Class for representing HDF5 spaces
H5S-class | Class for representing HDF5 spaces
H5S_H5D_subset_assign | Selecting and assigning subsets of HDF5-Spaces and HDF5-Datasets
H5T | Class for HDF5 datatypes.
H5T-class | Class for HDF5 datatypes.
h5types | These are all types that are used in HDF5
H5T_ARRAY | Class for HDF5 array datatypes.
H5T_ARRAY-class | Class for HDF5 array datatypes.
H5T_BITFIELD | Class for HDF5 integer-datatypes.
H5T_COMPLEX | Class for HDF5 complex datatypes
H5T_COMPLEX-class | Class for HDF5 complex datatypes
H5T_COMPOUND | Class for HDF5 compound datatypes.
H5T_COMPOUND-class | Class for HDF5 compound datatypes.
H5T_ENUM | Class for HDF5 enumeration datatypes.
H5T_ENUM-class | Class for HDF5 enumeration datatypes.
H5T_FLOAT | Class for HDF5 floating point datatypes.
H5T_FLOAT-class | Class for HDF5 floating point datatypes.
H5T_INTEGER | Class for HDF5 integer-datatypes.
H5T_INTEGER-class | Class for HDF5 integer-datatypes.
H5T_LOGICAL | Class for HDF5 logical datatypes. This is an enum with the 3 values FALSE, TRUE and NA mapped on values 0, 1 and 2. Is transparently mapped onto a logical variable
H5T_LOGICAL-class | Class for HDF5 logical datatypes. This is an enum with the 3 values FALSE, TRUE and NA mapped on values 0, 1 and 2. Is transparently mapped onto a logical variable
H5T_STRING | Class for HDF5 string datatypes.
H5T_STRING-class | Class for HDF5 string datatypes.
H5T_VLEN | Class for HDF5 variable-length datatypes.
H5T_VLEN-class | Class for HDF5 variable-length datatypes.
h5unlink | Wrapper functions to provide an 'h5' compatible interface.
h5version | Return the version of the HDF5-API

## -- I --

is.factor_ext | Various functions for 'factor_ext' objects
is.h5file | Wrapper functions to provide an 'h5' compatible interface.
is.H5R | Various functions for 'H5R' objects
is.H5R_DATASET_REGION | Various functions for 'H5R' objects
is.H5R_OBJECT | Various functions for 'H5R' objects
is_hdf5 | Check if a file is an HDF5 file

## -- L --

length.H5R | Various functions for 'H5R' objects
list-groups-datasets | List Groups and Datasets in object
list.attributes | Wrapper functions to provide an 'h5' compatible interface.
list.datasets | List Groups and Datasets in object
list.groups | List Groups and Datasets in object
list.objects | List Groups and Datasets in object

## -- N --

names.H5File | Get the names of the items in the group or at the '/' root of the file
names.H5Group | Get the names of the items in the group or at the '/' root of the file
names.H5R | Various functions for 'H5R' objects

## -- O --

openGroup | Wrapper functions to provide an 'h5' compatible interface.
openLocation | Wrapper functions to provide an 'h5' compatible interface.

## -- P --

print.data.frame_ext | Print a data frame with extended factor objects
print.factor_ext | Various functions for 'factor_ext' objects
print.H5R | Various functions for 'H5R' objects

## -- R --

rbind.H5D | Wrapper functions to provide an 'h5' compatible interface.
rbind.H5R | Various functions for 'H5R' objects
readDataSet | Wrapper functions to provide an 'h5' compatible interface.

## -- S --

subset_assign_h5.H5D | Selecting and assigning subsets of HDF5-Spaces and HDF5-Datasets
subset_h5.H5D | Selecting and assigning subsets of HDF5-Spaces and HDF5-Datasets
subset_h5.H5S | Selecting and assigning subsets of HDF5-Spaces and HDF5-Datasets

## -- T --

t.H5R | Various functions for 'H5R' objects
text_to_dtype | Convert a text description to a datatype

## -- V --

values | Various functions for 'factor_ext' objects
values.default | Various functions for 'factor_ext' objects
values.factor | Various functions for 'factor_ext' objects
values.factor_ext | Various functions for 'factor_ext' objects

## -- misc --

!=.factor_ext | Various functions for 'factor_ext' objects
$.types_env | Retrieving a copy of a type
==.factor_ext | Various functions for 'factor_ext' objects
[.factor_ext | Various functions for 'factor_ext' objects
[.H5D | Selecting and assigning subsets of HDF5-Spaces and HDF5-Datasets
[.H5R | Various functions for 'H5R' objects
[.H5S | Selecting and assigning subsets of HDF5-Spaces and HDF5-Datasets
[<-.factor_ext | Various functions for 'factor_ext' objects
[<-.H5D | Selecting and assigning subsets of HDF5-Spaces and HDF5-Datasets
[<-.H5R | Various functions for 'H5R' objects
[[.factor_ext | Various functions for 'factor_ext' objects
[[.H5File | Retrieve object from a group of file
[[.H5Group | Retrieve object from a group of file
[[.types_env | Retrieving a copy of a type
[[<-.factor_ext | Various functions for 'factor_ext' objects
[[<-.H5File | Retrieve object from a group of file
[[<-.H5Group | Retrieve object from a group of file