H5IdComponent-class {rhdf5}R Documentation

An S4 class representing H5 object

Description

A class representing a HDF5 identifier handle. HDF5 identifiers represent open files, groups, datasets, dataspaces, attributes, and datatypes.

Usage

## S4 method for signature 'H5IdComponent'
show(object)

## S4 method for signature 'H5IdComponent,character'
e1 & e2

## S4 method for signature 'H5IdComponent'
x$name

## S4 replacement method for signature 'H5IdComponent'
x$name <- value

## S4 method for signature 'H5IdComponent'
x[i, j, ..., drop = TRUE]

## S4 replacement method for signature 'H5IdComponent'
x[i, j, ...] <- value

Arguments

object

Object of class H5IdComponent

e1

An H5IdComponent object representing an H5 file or group.

e2

Character giving the path to an HDF5 group or dataset relative to e1.

x

Object of class H5IdComponent representing the HDF5 dataset from which to extract element(s) or in which to replace element(s).

name

Character giving the path to an HDF5 group or dataset relative to x.

value

Array-like R object containing value to be inserted into the HDF5 dataset.

i, j, ...

Indices specifying elements to extract or replace. Indices are numeric vectors or empty (missing) or NULL. Numeric values are coerced to integer as by as.integer (and hence truncated towards zero).

drop

If TRUE the result is coerced to the lowest possible dimension (see the examples). This only works for extracting elements, not for the replacement. See drop for further details.

Methods (by generic)

Slots

ID

integer of length 1. Contains the handle of C-type hid_t.

native

An object of class logical. If TRUE, array-like objects are treated as stored in HDF5 row-major rather than R column-major orientation. Using native = TRUE increases HDF5 file portability between programming languages. A file written with native = TRUE should also be read with native = TRUE


[Package rhdf5 version 2.37.4 Index]