
hybkit API
==================================

    The hybkit API provides a Python3 module with classes allowing parsing and manipulation
    of hyb-format data as python objects, including built-in analysis and plotting functionality
    for common tasks in hybrid sequence analysis.

    ============================= =====================================================
    :mod:`hybkit`                 Data classes for storing, evaluating, and iterating
                                  over records
    :mod:`~hybkit.settings`       Constants and settings information for hybkit classes
                                  and toolkit scripts
    :mod:`~hybkit.type_finder`    Class for customizable identification of segment type
                                  from reference identifiers
    :mod:`~hybkit.analysis`       Classes for predefined analyses of hyb records
    :mod:`~hybkit.plot`           Plotting methods for analysis results
    :mod:`~hybkit.util`           Support methods for executable scripts
    :mod:`~hybkit.errors`         Error classes for the hybkit package
    ============================= =====================================================

.. toctree::
   :maxdepth: 2

   hybkit
   hybkit.type_finder
   hybkit.analysis
   hybkit.plot
   hybkit.settings
   hybkit.util
   hybkit.errors
