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

Drug interaction partner storage and access. More...

Public Member Functions

def __init__ (s)
 Constructor. More...
 
def __str__ (s)
 
def SetDrugBankID (s, identifier)
 Set DrugBank identifier, DB*. More...
 
def SetName (s, name)
 Set drug name. More...
 
def SetGroups (s, strLst)
 Set drug class(es). More...
 
def SetAffectedOrganisms (s, strLst)
 Set organism name in which the drug is targeting the drug partner. More...
 
def SetDrugInteractions (s, strLst)
 Set DrugBank IDs of interacting drugs. More...
 
def SetUniProtAccession (s, identifier)
 Set UniProt accession number of drug. More...
 
def SetChEBI (s, ebiStr)
 Set drug's ChEBI identifier. More...
 
def AddPartner (s, partner)
 Add proteins which are in physical contact with the drug. More...
 
def GetDrugBankID (s)
 Get DrugBank identifier, DB*. More...
 
def GetName (s)
 Get drug name. More...
 
def GetGroups (s)
 Get drug class(es). More...
 
def GetAffectedOrganisms (s)
 Get organism name(s) in which the drug is targeting the drug partner. More...
 
def GetDrugInteractions (s)
 Get DrugBank IDs of interacting drugs. More...
 
def GetUniProtAccession (s)
 Get UniProt accession number of drug. More...
 
def GetChEBI (s)
 Get drug's ChEBI identifier. More...
 
def GetPartners (s)
 Get proteins which are in physical contact with the drug. More...
 

Detailed Description

Drug interaction partner storage and access.

Constructor & Destructor Documentation

◆ __init__()

def cls.DrugBankDrug.CDrugBankDrug.__init__ (   s)

Constructor.

Member Function Documentation

◆ __str__()

def cls.DrugBankDrug.CDrugBankDrug.__str__ (   s)

◆ AddPartner()

def cls.DrugBankDrug.CDrugBankDrug.AddPartner (   s,
  partner 
)

Add proteins which are in physical contact with the drug.

    @param partner @c List of CDrugBankDrugPartner objects.

◆ GetAffectedOrganisms()

def cls.DrugBankDrug.CDrugBankDrug.GetAffectedOrganisms (   s)

Get organism name(s) in which the drug is targeting the drug partner.

    @return @c List of @c String.

◆ GetChEBI()

def cls.DrugBankDrug.CDrugBankDrug.GetChEBI (   s)

Get drug's ChEBI identifier.

    @return @c String (can be empty).

◆ GetDrugBankID()

def cls.DrugBankDrug.CDrugBankDrug.GetDrugBankID (   s)

Get DrugBank identifier, DB*.

    @return @c String.

◆ GetDrugInteractions()

def cls.DrugBankDrug.CDrugBankDrug.GetDrugInteractions (   s)

Get DrugBank IDs of interacting drugs.

    @return @c List of @c Strings.

◆ GetGroups()

def cls.DrugBankDrug.CDrugBankDrug.GetGroups (   s)

Get drug class(es).

    @return @c List of @c String, eg. 'approved', 'illicit', 'withdrawn'.

◆ GetName()

def cls.DrugBankDrug.CDrugBankDrug.GetName (   s)

Get drug name.

    @return @c String.

◆ GetPartners()

def cls.DrugBankDrug.CDrugBankDrug.GetPartners (   s)

Get proteins which are in physical contact with the drug.

    @return @c List of CDrugBankDrugPartner objects.

◆ GetUniProtAccession()

def cls.DrugBankDrug.CDrugBankDrug.GetUniProtAccession (   s)

Get UniProt accession number of drug.

    @return @c String (can be empty).

◆ SetAffectedOrganisms()

def cls.DrugBankDrug.CDrugBankDrug.SetAffectedOrganisms (   s,
  strLst 
)

Set organism name in which the drug is targeting the drug partner.

    @param strLst @c List of @c Strings.

◆ SetChEBI()

def cls.DrugBankDrug.CDrugBankDrug.SetChEBI (   s,
  ebiStr 
)

Set drug's ChEBI identifier.

    @param ebiStgr (@c String) (Can be empty.)

◆ SetDrugBankID()

def cls.DrugBankDrug.CDrugBankDrug.SetDrugBankID (   s,
  identifier 
)

Set DrugBank identifier, DB*.

    @param identifier (@c String) Unique DrugBank identifier, @c DB*.

◆ SetDrugInteractions()

def cls.DrugBankDrug.CDrugBankDrug.SetDrugInteractions (   s,
  strLst 
)

Set DrugBank IDs of interacting drugs.

    @param strLst @c List of @c Strings, all valid DrugBank identifiers,
     @c DB*.

◆ SetGroups()

def cls.DrugBankDrug.CDrugBankDrug.SetGroups (   s,
  strLst 
)

Set drug class(es).

    @param strLst @c List of @c Strings which describe the FDA-like status
    of the drug, such as 'approved', 'withdrawn', etc.

◆ SetName()

def cls.DrugBankDrug.CDrugBankDrug.SetName (   s,
  name 
)

Set drug name.

    @param name  Drug full text official name.

◆ SetUniProtAccession()

def cls.DrugBankDrug.CDrugBankDrug.SetUniProtAccession (   s,
  identifier 
)

Set UniProt accession number of drug.

    @param identifier (@c String) (Can be empty, if the drug is not a
     protein.)

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