Class for HDF5 enumeration datatypes.

Source: R/R6Classes_H5T.R

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

See also

H5T

Examples

nucleotide_enum <- H5T_ENUM$new(labels=c("A", "C", "G", "T"), values=0:3)
nucleotide_enum
#> Class: H5T_ENUM
#> Datatype: H5T_ENUM {
#>       undefined integer;
#>       "A"                0;
#>       "C"                1;
#>       "G"                2;
#>       "T"                3;
#>    }
# For HDF5 1.8.16 or higher, the size and precision are set optimally
nucleotide_enum$get_size()
#> [1] 1
nucleotide_enum$get_precision()
#> [1] 2