core.lib.genomebuild
====================

.. py:module:: core.lib.genomebuild


Classes
-------

.. autoapisummary::

   core.lib.genomebuild.GenomeBuild


Module Contents
---------------

.. py:class:: GenomeBuild(*args, **kwds)



   Enumeration of genome build: the reference genome release that a scoring file
   is aligned to.

   >>> GenomeBuild.GRCh38
   GenomeBuild.GRCh38


   .. py:method:: from_string(build: str) -> GenomeBuild | None
      :classmethod:


      :param build: genome build string
      :return: :class:`GenomeBuild`
      :raises ValueError: From an unsupported build string

      >>> GenomeBuild.from_string("GRCh38")
      GenomeBuild.GRCh38
      >>> str(GenomeBuild.from_string("GRCh37"))
      'GRCh37'
      >>> GenomeBuild.from_string("NR") is None
      True
      >>> GenomeBuild.from_string("pangenome")
      Traceback (most recent call last):
      ...
      ValueError: Can't match build='pangenome'



   .. py:attribute:: GRCh37
      :value: 'GRCh37'



   .. py:attribute:: GRCh38
      :value: 'GRCh38'



   .. py:attribute:: NCBI35
      :value: 'NCBI35'



   .. py:attribute:: NCBI36
      :value: 'NCBI36'