RToH5: Low-level conversion functions from R to HDF5 and vice versa

Description Usage Arguments Details Value Author(s)

View source: R/convert.R

Description

Low-level conversion functions from R to HDF5 and vice versa

Usage

1
2
3
4
5
6
RToH5(Robj, dtype, nelem)

H5ToR_Pre(dtype, nelem)

H5ToR_Post(Robj, dtype, nelem, flags = getOption("hdf5r.h5tor_default"),
  id = -1)

Arguments

Robj

The R-object to transfer to HDF5

dtype

Datatype of the HDF5 object. Of class H5T

nelem

Number of elements to copy

flags

Some flags governing edge cases of conversion from HDF5 to R. This is related to how integers are being treated and the issue of R not being able to natively represent 64bit integers and not at all being able to represent unsigned 64bit integers (even using add-on packages). The constants governing this are part of h5const. The relevant ones start with the term H5TOR and are documented there. The default set here returns a regular 32bit integer if it doesn't lead to an overflow and returns a 64bit integer from the bit64 package otherwise. For 64bit unsigned int that are larger than 64bit signed int, it is truncated (the default; but can also be set to NA).

id

When creating a reference, an id for the file (or an object in the file) is needed. By default -1, which will work with everything except references.

Details

These are the low-level function that dispatch the R object to HDF5 object conversion to the underlying C code. None of these should be accessed by the end-user under normal circumstances. See also convertRoundTrip for an example of how to use them.

Value

The converted object or the buffer into which the object is written.

Author(s)

Holger Hoefling


hdf5r documentation built on Nov. 16, 2021, 1:06 a.m.