.. _api_tabix:

=====
Tabix
=====

.. contents::

The Tabix module provides support for working with Tabix-indexed files.

vcfpy.tabix.TabixFile
---------------------

.. autoclass:: vcfpy.tabix.TabixFile
    :members:

vcfpy.tabix.TabixFileIter
-------------------------

.. autoclass:: vcfpy.tabix.TabixFileIter
    :members:

vcfpy.tabix.TabixIndex
----------------------

.. autoclass:: vcfpy.tabix.TabixIndex
    :members:

Tabix Data Structures
---------------------

.. autoclass:: vcfpy.tabix.Chunk
    :members:

.. autoclass:: vcfpy.tabix.Bin
    :members:

.. autoclass:: vcfpy.tabix.SequenceIndex
    :members:

.. autoclass:: vcfpy.tabix.FileFormat
    :members:

Tabix Utilities
---------------

.. autofunction:: vcfpy.tabix.read_index

.. autofunction:: vcfpy.tabix.reg2bins