Attribute: The Attribute Class

Description Usage Arguments Details References See Also

Description

An HDF5 Attribute object is used to store meta data about a primary data object like DataSet, H5Group or H5File. The functions described in this section show a low–level interface to read and write attributes. See H5Location for the easier-to-use h5attr convenience functions.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
writeAttribute(.Object, data = GetDimensions(data), transpose = TRUE)

## S4 method for signature 'Attribute'
writeAttribute(.Object, data = GetDimensions(data),
  transpose = TRUE)

readAttribute(.Object)

## S4 method for signature 'Attribute'
readAttribute(.Object)

Arguments

.Object

Attribute; S4 object of class Attribute.

data

object; Object to be stored in HDF5 file, can be either of type vector, matrix or array.

transpose

logical; Determine if data object should be transposed.

Details

Attributes are assumed to be like small DataSets since they can store the same data types in homogeneous objects like vectors, matrices and arrays. However, there are two important differences compared to DataSet objects:

  1. Attributes do not support compression or chunking.

  2. Subsetting is not possible for attribute data.

References

http://www.hdfgroup.org/HDF5/doc/H5.intro.html#Intro-OAttributes

See Also

H5Location-Attribute


h5 documentation built on Aug. 30, 2017, 5:06 p.m.