Learn R Programming

h5 (version 0.9.1)

CommonFG-DataSet: Functions to Create/Open DataSets in CommonFG objects

Description

Although DataSet objects can implicitly be created using subsetting operators (see CommonFG) h5 implements more explicit functions (used by subsetting operators under the hood) to create and open DataSets.

Usage

createDataSet(.Object, datasetname, data, type, dimensions,
  chunksize = ChunkSize(data), maxdimensions = rep(NA_integer_,
  length(GetDimensions(data))), compression = 4L, size = -1)

## S3 method for class 'CommonFG,character,missing,character,integer,ANY,ANY,ANY,ANY': createDataSet(.Object, datasetname, type, dimensions, chunksize, maxdimensions, compression, size)

## S3 method for class 'CommonFG,character,ANY,missing,missing,ANY,ANY,ANY,missing': createDataSet(.Object, datasetname, data, chunksize, maxdimensions, compression)

openDataSet(.Object, datasetname, type)

## S3 method for class 'CommonFG,character': openDataSet(.Object, datasetname, type)

Arguments

.Object
CommonFG; S4 object of class CommonFG;
datasetname
character; HDF5 DataSet name to be used.
data
object; Object to be stored in HDF5 file, can be either of type vector, matrix or array.
type
character; Character specifying data type, can be either one of: [object Object],[object Object],[object Object],[object Object]
dimensions
integer; Dimensions of dataset to be created.
chunksize
integer; Chunksize to be used for dataset.
maxdimensions
integer; Maximum dimensions used for dataset, NA is mapped to 'unlimited'.
compression
integer; Default GZIP compression level to be used, from 0 (no compression) to 9 (maximum compression), defaults to 4.
size
integer; Size of data type to be used, only relevant for character strings.