Package 'hdf5lib'

Title: Headers and Static Libraries for 'HDF5'
Description: Provides a self-contained, static build of the 'HDF5' (Hierarchical Data Format 5) 'C' library (release 2.1.1) for R package developers. Designed for use in the 'LinkingTo' field, it enables zero-dependency integration by building the library entirely from source during installation. Additionally, it compiles and internally links a comprehensive suite of advanced compression filters and their 'HDF5' plugins (Zstd, LZ4, Blosc/Blosc2, Snappy, ZFP, Bzip2, LZF, Bitshuffle, szip, and gzip). These plugins are integrated out-of-the-box, allowing downstream packages to utilize high-performance compression directly through the standard 'HDF5' API while keeping the underlying third-party headers fully encapsulated. 'HDF5' is developed by The HDF Group <https://www.hdfgroup.org/>.
Authors: Daniel P. Smith [aut, cre] (ORCID: <https://orcid.org/0000-0002-2479-2044>), Alkek Center for Metagenomics and Microbiome Research [cph, fnd], The HDF Group [ctb, cph] (HDF5 library), The Board of Trustees of the University of Illinois [cph] (NCSA HDF5), Jean-loup Gailly [ctb, cph] (zlib-ng library), Mark Adler [ctb, cph] (zlib-ng library), Kiyoshi Masui [ctb, cph] (bitshuffle library), Julian R Seward [ctb, cph] (bzip2 library), Francesc Alted [ctb, cph] (blosc and blosc2 libraries), Blosc Development Team [cph] (blosc and blosc2 libraries), Zeev Tarento [ctb, cph] (csnappy library), Google Inc. [cph] (csnappy library), Mathis Rosenhauer [ctb, cph] (libaec library), Moritz Hanke [ctb] (libaec library), Joerg Behrens [ctb] (libaec library), Luis Kornblueh [ctb] (libaec library), Marc Alexander Lehmann [ctb, cph] (liblzf library), Yann Collet [ctb, cph] (lz4 and zstd libraries), Lawrence Livermore National Security, LLC [cph] (zfp library), Meta Platforms, Inc. and affiliates [cph] (zstd library), Yuta Mori [ctb] (zstd library)
Maintainer: Daniel P. Smith <[email protected]>
License: MIT + file LICENSE
Version: 2.1.1.1
Built: 2026-05-14 17:55:43 UTC
Source: https://github.com/cmmr/hdf5lib

Help Index

Get C/C++ Compiler Flags for hdf5lib

Description

Provides the required C/C++ compiler flags to find the HDF5 header files bundled with the hdf5lib package.

Usage

c_flags(api = "latest")

Arguments

api

A numeric value specifying the HDF5 API version to use (e.g., 1.14 or 114 for v1.14), or the string "latest". This adds a preprocessor directive like -DH5_USE_114_API_DEFAULT to ensure that the compiled code uses symbols compatible with a specific version of the HDF5 API. This is useful for maintaining compatibility with older HDF5 versions. Supported values are 2.0, 1.14, 1.12, 1.10, 1.8, and 1.6. Defaults to "latest", which corresponds to the newest supported API version.

Value

A scalar character vector containing the compiler flags (e.g., the -I path to the package's inst/include directory).

See Also

ld_flags()

Examples

c_flags()
c_flags(api = 1.14)

Get C/C++ Linker Flags for hdf5lib

Description

Provides the required linker flags to link against the static HDF5 library (libhdf5z.a) bundled with the hdf5lib package.

Usage

ld_flags(api = "latest")

Arguments

api

A numeric value or the string "latest". This parameter is included for consistency with c_flags() and is reserved for future use; it currently has no effect on the linker flags. Defaults to "latest".

Value

A scalar character vector containing the linker flags.

See Also

c_flags()

Examples

ld_flags()