takane
Validators for ArtifactDB file formats
Loading...
Searching...
No Matches
takane::bed_file Namespace Reference

Definitions for BED files. More...

Functions

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

Detailed Description

Definitions for BED files.

Function Documentation

◆ validate()

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

If Options::bed_file_strict_check is provided, it is used to perform stricter checking of the BED file contents and indices. Currently, 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
pathPath to the directory containing the BED file.
metadataMetadata for the object, typically read from its OBJECT file.
optionsValidation options.