saveDelayed: Save a DelayedMatrix

View source: R/saveDelayed.R

saveDelayedR Documentation

Save a DelayedMatrix

Description

Save a DelayedMatrix object to a location within a HDF5 file.

Usage

saveDelayed(x, file, path = "delayed")

Arguments

x

A DelayedArray object.

file

String containing a path to a HDF5 file. This will be created if it does not yet exist.

path

String containing a path inside a HDF5 file. This should not already exist, though any parent groups should already be constructed.

Details

See the various saveDelayedObject methods for how each suite of delayed operations is handled. Also see https://artifactdb.github.io/chihaya/ for more details on the data layout inside the HDF5 file.

Value

The contents of x are written to file and a NULL is invisibly returned.

Author(s)

Aaron Lun

Examples

library(HDF5Array)
X <- rsparsematrix(100, 20, 0.1)
Y <- DelayedArray(X)
Z <- log2(Y + 1)

temp <- tempfile(fileext=".h5")
saveDelayed(Z, temp)
rhdf5::h5ls(temp)


LTLA/DelayedArraySaver documentation built on Sept. 19, 2024, 1:37 p.m.