Metafile

bgen_reader.create_metafile(bgen_filepath: str | Path, metafile_filepath: str | Path, verbose: bool = True)

Create variants metadata file.

Variants metadata file helps speed up subsequent reads of the associated bgen file.

Parameters:

• bgen_filepath (str) – Bgen file path.

• metafile_file (str) – Metafile file path.

• verbose (bool) – True to show progress; False otherwise.

Examples

>>> import os
>>> from bgen_reader import create_metafile, example_filepath
>>>
>>> filepath = example_filepath("example.32bits.bgen")
>>> metafile_filepath = filepath.with_suffix(".metafile")
>>>
>>> try:
...     create_metafile(filepath, metafile_filepath, verbose=False)
... finally:
...     if metafile_filepath.exists():
...         os.remove(metafile_filepath)