Skip to contents

Write and open FDS v1 HDF5 fmri frames

Source: R/frame_h5.R
write_frame_h5.Rd

`write_frame_h5()` validates the source-free FDS v1 semantic manifest, then streams every separately bound array into a sibling temporary HDF5 file. The destination becomes visible only after arrays, manifests, digests, and a complete commit marker have been flushed. `open_frame_h5()` reads manifests and dataset metadata only; numerical arrays remain lazy.

Usage

write_frame_h5(
  x,
  path,
  overwrite = FALSE,
  chunk_dims = NULL,
  layout = c("balanced", "imagewise", "featurewise"),
  target_chunk_bytes = getOption("fmristore.target_chunk_bytes", 1024^2),
  memory_budget = getOption("fmridataset.block_budget", 512 * 1024^2)
)

open_frame_h5(path)

Arguments

x

An `fmri_frame`.

path

Destination or source HDF5 path.

overwrite

Atomically replace an existing destination.

chunk_dims

Optional two-element HDF5 chunk shape applied to arrays.

layout

Workload profile used when `chunk_dims` is absent: balanced, imagewise, or featurewise.

target_chunk_bytes

Desired physical chunk size. The hard `memory_budget` always takes precedence.

memory_budget

Hard maximum bytes for one source-read block.

Value

`write_frame_h5()` invisibly returns the normalized committed path; `open_frame_h5()` returns a lazy `fmri_frame`.