takane::bcf_file Namespace Reference

Definitions for BCF files. More...

Functions
void	validate (const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)

Detailed Description

Definitions for BCF files.

Function Documentation

validate()

void takane::bcf_file::validate ( const std::filesystem::path & path, const ObjectMetadata & metadata, Options & options )

inline

If Options::bcf_file_strict_check is provided, it is used to perform stricter checking of the BCF file contents and indices. By default, we don't look past the magic number to verify the files as this requires a dependency on heavy-duty libraries like, e.g., HTSlib.

Parameters

path	Path to the directory containing the BCF file.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.