# 1 Motivation

Rhdf5lib provides the C and C++ HDF5 libraries. It is primarily useful to developers of other R packages who want to make use of the capabilities of the HDF5 library directly in the C or C++ code of their own packages, rather than using a higher level interface such as the rhdf5 package. Using Rhdf5lib make life easier for users, as they do not have to worry about installing libraries at a system level, and for developers since they can work with a defined version of the library rather than developing strategies to cope with the potential for multiple versions.

Rhdf5 is very much inspired by the zlibbioc and Rhtslib packages.

# 2 Usage

There is an example package, usingRhdf5lib, that demonstrates how packages should link to Rhdf5lib.

## 2.2 Locating the library headers

In order for the C/C++ compiler to find the HDF5 headers during package installation, add Rhtslib to the LinkingTo field of the DESCRIPTION file of your package, e.g.

LinkingTo: Rhtslib

In you C or C++ code files, you can then use the standard include techniques, e.g., #include "hdf5.h" or #include "c++/hdf5.h". C header files do not need a subfolder specified, while C++ headers are located under c++. You can inspect the header files manually to check their names and declared functions. To find their location on your system you can use the following code:

system.file(package="Rhdf5lib", "include")
## [1] "/tmp/RtmpFSRrIL/Rinst15b1695bb59d/Rhdf5lib/include"

# 3 Funding

MLS was supported by the BMBF-funded Heidelberg Center for Human Bioinformatics (HD-HuB) within the German Network for Bioinformatics Infrastructure (de.NBI), Förderkennzeichen #031A537B

# Session info

## R version 3.4.2 (2017-09-28)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 16.04.3 LTS
##
## Matrix products: default
## BLAS: /home/biocbuild/bbs-3.6-bioc/R/lib/libRblas.so
## LAPACK: /home/biocbuild/bbs-3.6-bioc/R/lib/libRlapack.so
##
## locale:
##  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C
##  [3] LC_TIME=en_US.UTF-8        LC_COLLATE=C
##  [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8
##  [7] LC_PAPER=en_US.UTF-8       LC_NAME=C
## [13] stringr_1.2.0   digest_0.6.12   evaluate_0.10.1