H5T_ENUM-class: Class for HDF5 enumeration datatypes.

In hdf5r: Interface to the 'HDF5' Binary Data Format

Class for HDF5 enumeration datatypes.

Description

Inherits from class H5T.

Value

Object of class H5T_ENUM.

Methods

new(labels, values = seq_along(labels), id = NULL)

Create an enumeration datatype. This is either a factor-like object or a logical variable (that is internally represented as an ENUM-type.

Parameters

labels

The labels of the ENUM-type

values

The values corresponding to the labels

id

Internal use only

get_labels()

Return all the labels of the enumeration type

get_values()

Return the values of the enumeration type

set_size(size)

Base type of every enum is H5T_INTEGER. This disables the set_size function

get_super()

Returns H5T_INTEGER that is the base type of the enumeration

describe()

Print a detailed description of the datatype; this is experimental

Author(s)

Holger Hoefling

See Also

H5T

Examples

nucleotide_enum <- H5T_ENUM$new(labels=c("A", "C", "G", "T"), values=0:3)
nucleotide_enum
# For HDF5 1.8.16 or higher, the size and precision are set optimally
nucleotide_enum$get_size()
nucleotide_enum$get_precision()

hdf5r documentation built on April 4, 2025, 2:38 a.m.