pybedtools.bedtool.BedTool.tabix

BedTool.tabix(in_place: bool = True, force: bool = False, is_sorted: bool = False) → BedTool

Prepare a BedTool for use with Tabix.

Returns a new BedTool that has been BGZIP compressed and indexed by tabix.

Parameters:

in_placebool

If True (default), then assume the file is already sorted and replace the existing file with the BGZIPed version.

forcebool

If True (default is False), then overwrite both the index and the BGZIP file.

is_sortedbool

If True (default is False), then assume the file is already sorted so that BedTool.bgzip() doesn’t have to do that work.