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 = -1, maxdimensions = NA_integer_, compression = 4L, size = -1)
 "createDataSet"(.Object, datasetname, type, dimensions, chunksize, maxdimensions, compression, size)
 "createDataSet"(.Object, datasetname, data, chunksize, maxdimensions, compression, size)
 "createDataSet"(.Object, datasetname, data, chunksize, maxdimensions, compression)
openDataSet(.Object, datasetname, type)
"openDataSet"(.Object, datasetname, type)
list.datasets(.Object, path = "/", full.names = TRUE, recursive = TRUE, follow.links = FALSE)
"list.datasets"(.Object, path = "/", full.names = TRUE, recursive = TRUE, follow.links = FALSE)
existsDataSet(.Object, datasetname)
"existsDataSet"(.Object, datasetname)

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:

double: Double precision floating--point number.
integer: 32--Bit integer.
logical: Boolean, which is mapped to 1/0 integer values.
character: Variable--length character strings.

dimensions

integer; Dimensions of dataset to be created.

chunksize

integer; Chunksize to be used for dataset. If set to NA, chunking is disabled for dataset; maxdimensionions and compression have no effect and extensions of DataSet (e.g. through cbind, rbind) are not possible.

maxdimensions

integer; Maximum dimensions used for dataset, NA sets maxdimensions to 'unlimited'.

compression

integer; Default GZIP compression level to be used, from 0 (no compression) to 9 (maximum compression), defaults to 4.

size

numeric; Character length for fixed-length string data types. Default value of -1 creates variable-length strings.

path

character; Relative path to .Object.

full.names

character; Specify if absolute DataSet path names should be returned.

recursive

logical; Specify DatSets should be retrieved recursively from .Object.

follow.links

logical; Specify if symbolic links should be followed (only applies if recursive = TRUE).