Data Integrator (Python API)
Public Member Functions | List of all members
cls.HSGeneOrthologyMapping.CHSGeneOrthologyMappingBase Class Reference

Base class for Homo sapiens to other species gene mappings. More...

Inheritance diagram for cls.HSGeneOrthologyMapping.CHSGeneOrthologyMappingBase:
Inheritance graph
[legend]
Collaboration diagram for cls.HSGeneOrthologyMapping.CHSGeneOrthologyMappingBase:
Collaboration graph
[legend]

Public Member Functions

def Convert (s, key, isHS=True)
 Convert from orthologous gene to HS gene. More...
 
- Public Member Functions inherited from cls.PairwiseMapperBase.CEnsemblMapperBase
def Convert (s, key, srcDbToken, dstDbToken)
 Map from one database to any other. More...
 
- Public Member Functions inherited from cls.PairwiseMapperBase.CPairwiseMapperBase
def __init__ (s, paths)
 Constructor. More...
 
def GetPaths (s)
 Get CPaths object stored here. More...
 

Detailed Description

Base class for Homo sapiens to other species gene mappings.

Establishes a framework for mapping HS genes to any other species. We have
chosen this way, as we are not sure which additional organisms we want to
see included, therefore this base class has been implemented and
facilitates creation of additional, unforeseen orthology mappings.

Member Function Documentation

◆ Convert()

def cls.HSGeneOrthologyMapping.CHSGeneOrthologyMappingBase.Convert (   s,
  key,
  isHS = True 
)

Convert from orthologous gene to HS gene.

Parameters
keyIdentifier to be converted.
isHSTrue if the key is a H. sapiens identifier. The result is then to gene from the orthologous species. If set to False, the conversion is made from the foreign organism to HS.
Returns
A list of COrthlogPair instances. Can be empty.

The documentation for this class was generated from the following file: