Skip to contents

Validate HDF5 File Against Latent Spec

Source: R/latent_vec.R
validate_latent_file.Rd

Performs basic checks on an HDF5 file to verify if it conforms to the essential structure and dimension consistency defined by the `BasisEmbeddingSpec.yaml` specification.

Usage

validate_latent_file(file_path)

Arguments

file_path

Character string specifying the path to the HDF5 file.

Value

Logical `TRUE` if basic checks pass, `FALSE` otherwise. Issues warnings for inconsistencies found. Throws an error if the file cannot be opened or fundamental groups/datasets are missing.

Details

Checks performed:

  • File existence and HDF5 readability.

  • Presence of mandatory groups: `/header`, `/basis`, `/scans`.

  • Presence of mandatory datasets: `/header/dim`, `/mask`, `/basis/basis_matrix`, at least one scan group under `/scans`, and its `embedding` dataset.

  • Dimension consistency between header, mask, basis, and embedding.