freqsap.dbsnp

Module for interacting with the dbSNP database API.

Classes

DBSNP

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

Module Contents

class freqsap.dbsnp.DBSNP(timeout: int = 10)

Bases: freqsap.interfaces.VariantFrequencyAPI

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

_timeout = 10

_num_required_sections = 2

_num_required_columns = 6

get(variation: freqsap.variation.Variation) → freqsap.report.ReferenceSNPReport | None

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

Parameters:

variation (Variation) – Variation for which to get the report.

Returns:

Report if it is found on dbSNP, otherwise None.

Return type:

ReferenceSNPReport | None

available() → bool

Check whether the service is available.

Returns:

True if the service is available, False otherwise.

Return type:

bool