freqsap.dbsnp
=============

.. py:module:: freqsap.dbsnp

.. autoapi-nested-parse::

   Module for interacting with the dbSNP database API.



Classes
-------

.. autoapisummary::

   freqsap.dbsnp.DBSNP


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

.. py:class:: DBSNP(timeout: int = 10)

   Bases: :py:obj:`freqsap.interfaces.VariantFrequencyAPI`


   Interface to interact with the dbSNP database to obtain frequency information for specific variants.


   .. py:attribute:: _timeout
      :value: 10



   .. py:attribute:: _num_required_sections
      :value: 2



   .. py:attribute:: _num_required_columns
      :value: 6



   .. py:method:: get(variation: freqsap.variation.Variation) -> freqsap.report.ReferenceSNPReport | None

      Get the ReferenceSNPReport for the given single amino-acid polymorphism.

      :param variation: Variation for which to get the report.
      :type variation: Variation

      :returns: Report if it is found on dbSNP, otherwise None.
      :rtype: ReferenceSNPReport | None



   .. py:method:: available() -> bool

      Check whether the service is available.

      :returns: True if the service is available, False otherwise.
      :rtype: bool