takane::bam_file Namespace Reference

Definitions for BAM files. More...

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

Detailed Description

Definitions for BAM files.

Function Documentation

validate()

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

inline

If Options::bam_file_strict_check is provided, it is used to perform stricter checking of the BAM 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 BAM file.
metadata	Metadata for the object, typically read from its OBJECT file.
options	Validation options.