models.py 36 KB
Newer Older
1
2
3
4
"""
Models used in iPPI-DB
"""

Hervé  MENAGER's avatar
Hervé MENAGER committed
5
from __future__ import unicode_literals
6

7
import operator
8
import re
Hervé  MENAGER's avatar
Hervé MENAGER committed
9

10
from django.conf import settings
11
12
13
14
from django.core.exceptions import ValidationError
from django.db import models
from django.db.models import FloatField, IntegerField, BooleanField
from django.db.models import Max, Count, F, Q, Case, When
15
from django.db.models.functions import Cast
16
from django.utils.translation import ugettext_lazy as _
Hervé  MENAGER's avatar
Hervé MENAGER committed
17

18
from .utils import FingerPrinter, smi2inchi, smi2inchikey
19
from .ws import get_pubmed_info, get_google_patent_info, get_uniprot_info, get_taxonomy_info, get_go_info, get_pfam_info
20

Hervé  MENAGER's avatar
Hervé MENAGER committed
21

22
23
24
25
26
27
28
29
30
31
32
33
34
35
class AutoFillableModel(models.Model):
    """
    AutoFillableModel makes it possible to automatically fill model fields from
    external sources in the autofill() method
    The save method allows to either include autofill or not. in autofill kwarg is
    set to True, save() will first call autofill(), otherwise it won't
    """

    class Meta:
        abstract = True

    def save(self, *args, **kwargs):
        if kwargs.get('autofill') is True:
            self.autofill()
36
37
        if 'autofill' in kwargs:
            del kwargs['autofill']
Hervé  MENAGER's avatar
Hervé MENAGER committed
38
        super(AutoFillableModel, self).save(*args, **kwargs)
39
40
41


class Bibliography(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
42
    """
Hervé  MENAGER's avatar
Hervé MENAGER committed
43
44
    Bibliography references
    (publications or patents)
Hervé  MENAGER's avatar
Hervé MENAGER committed
45
46
    """
    SOURCES = (
47
48
49
        ('PM', 'PubMed ID'),
        ('PT', 'Patent'),
        ('DO', 'DOI ID')
Hervé  MENAGER's avatar
Hervé MENAGER committed
50
    )
51
52
53
54
55
    id_source_validators = dict(
        PM=re.compile("^[0-9]+$"),
        PT=re.compile("^.*$"),
        DO=re.compile("^.*$"),
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
56
57
    source = models.CharField(
        'Bibliographic type', max_length=2, choices=SOURCES, default='PM')
Hervé  MENAGER's avatar
Hervé MENAGER committed
58
59
    id_source = models.CharField('Bibliographic ID', max_length=25)
    title = models.CharField('Title', max_length=300)
60
    journal_name = models.CharField('Journal name', max_length=50, null=True, blank=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
61
62
    authors_list = models.CharField('Authors list', max_length=500)
    biblio_year = models.PositiveSmallIntegerField('Year')
63
    cytotox = models.BooleanField('Cytotoxicity data', default=False)
Rachel TORCHET's avatar
Rachel TORCHET committed
64
65
66
67
    in_silico = models.BooleanField('in silico study', default=False)
    in_vitro = models.BooleanField('in vitro study', default=False)
    in_vivo = models.BooleanField('in vivo study', default=False)
    in_cellulo = models.BooleanField('in cellulo study', default=False)
Hervé  MENAGER's avatar
Hervé MENAGER committed
68
69
    pharmacokinetic = models.BooleanField(
        'pharmacokinetic study', default=False)
Rachel TORCHET's avatar
Rachel TORCHET committed
70
    xray = models.BooleanField('X-Ray data', default=False)
Hervé  MENAGER's avatar
Hervé MENAGER committed
71

72
    def autofill(self):
Hervé  MENAGER's avatar
Hervé MENAGER committed
73
74
75
76
        """
        fetch information from external services
        (Pubmed or Google patents)
        """
77
78
79
        if self.source == 'PM':
            info = get_pubmed_info(self.id_source)
        else:
80
            info = get_google_patent_info(self.id_source)
81
82
83
84
        self.title = info['title']
        self.journal_name = info['journal_name']
        self.authors_list = info['authors_list']
        self.biblio_year = info['biblio_year']
Hervé  MENAGER's avatar
Hervé MENAGER committed
85

86
87
88
89
90
91
92
93
94
95
    def clean(self):
        super().clean()
        id_source_validator = self.id_source_validators[self.source]
        if not id_source_validator.match(self.id_source):
            raise ValidationError(
                dict(
                    id_source=_("Must match pattern %s for this selected source" % id_source_validator.pattern)
                )
            )

Hervé  MENAGER's avatar
Hervé MENAGER committed
96
97
98
    class Meta:
        verbose_name_plural = "bibliographies"

99
100
    def __str__(self):
        return '{}, {}'.format(self.source, self.id_source)
101

Hervé  MENAGER's avatar
Hervé MENAGER committed
102

103
class Taxonomy(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
104
105
106
107
    """
    Taxonomy IDs (from NCBI Taxonomy) 
    and the corresponding human-readable name
    """
Hervé  MENAGER's avatar
Hervé MENAGER committed
108
109
    taxonomy_id = models.DecimalField(
        'NCBI TaxID', unique=True, max_digits=9, decimal_places=0)
Hervé  MENAGER's avatar
Hervé MENAGER committed
110
    name = models.CharField('Organism name', max_length=200)
111

112
    def autofill(self):
Hervé  MENAGER's avatar
Hervé MENAGER committed
113
114
115
116
        """
        fetch information from external services
        (NCBI Entrez)
        """
117
118
119
        info = get_taxonomy_info(self.taxonomy_id)
        self.name = info['scientific_name']

120
121
122
    def __str__(self):
        return self.name

Hervé  MENAGER's avatar
Hervé MENAGER committed
123
124
    class Meta:
        verbose_name_plural = "taxonomies"
Hervé  MENAGER's avatar
Hervé MENAGER committed
125

Hervé  MENAGER's avatar
Hervé MENAGER committed
126

127
class MolecularFunction(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
128
129
130
131
    """
    Molecular functions (from Gene Ontology) 
    and the corresponding human-readable description
    """
Hervé  MENAGER's avatar
Hervé MENAGER committed
132
    go_id = models.CharField('Gene Ontology ID', unique=True, max_length=10)
Hervé  MENAGER's avatar
Hervé MENAGER committed
133
    # GO term id format: 'GO:0000000'
Hervé  MENAGER's avatar
Hervé MENAGER committed
134
135
    description = models.CharField('description', max_length=500)

136
    def autofill(self):
Hervé  MENAGER's avatar
Hervé MENAGER committed
137
138
139
140
        """
        fetch information from external services
        (EBI OLS)
        """
141
142
143
        info = get_go_info(self.go_id)
        self.description = info['label']

144
145
146
147
    @property
    def name(self):
        return self.go_id + ' ' + self.description

148
149
150
    def __str__(self):
        return self.description

Hervé  MENAGER's avatar
Hervé MENAGER committed
151

152
class Protein(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
153
154
155
156
    """
    Protein information (from Uniprot) 
    and the corresponding human-readable name
    """
Hervé  MENAGER's avatar
Hervé MENAGER committed
157
    uniprot_id = models.CharField('Uniprot ID', unique=True, max_length=10)
Hervé  MENAGER's avatar
Hervé MENAGER committed
158
159
    recommended_name_long = models.CharField(
        'Uniprot Recommended Name (long)', max_length=75)
Hervé  MENAGER's avatar
Hervé MENAGER committed
160
161
162
    short_name = models.CharField('Short name', max_length=50)
    gene_name = models.CharField('Gene name', unique=True, max_length=30)
    entry_name = models.CharField('Entry name', max_length=30)
163
    organism = models.ForeignKey('Taxonomy', models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
164
165
    molecular_functions = models.ManyToManyField(MolecularFunction)

166
    def autofill(self):
Hervé  MENAGER's avatar
Hervé MENAGER committed
167
168
169
170
        """
        fetch information from external services
        (Uniprot) and create Taxonomy/Molecular Functions if needed
        """
171
        info = get_uniprot_info(self.uniprot_id)
172
        self.recommended_name_long = info['recommended_name']
173
174
        self.gene_name = info['gene']
        self.entry_name = info['entry_name']
175
        self.short_name = info['short_name']
176
177
178
179
180
        try:
            taxonomy = Taxonomy.objects.get(taxonomy_id=info['organism'])
        except Taxonomy.DoesNotExist:
            taxonomy = Taxonomy()
            taxonomy.taxonomy_id = info['organism']
181
            taxonomy.save(autofill=True)
182
        self.organism = taxonomy
183
        super(Protein, self).save()
184
185
186
187
188
189
        for go_id in info['molecular_functions']:
            try:
                mol_function = MolecularFunction.objects.get(go_id=go_id)
            except MolecularFunction.DoesNotExist:
                mol_function = MolecularFunction()
                mol_function.go_id = go_id
190
                mol_function.save(autofill=True)
191
            self.molecular_functions.add(mol_function)
192

193
194
195
    def __str__(self):
        return '{} ({})'.format(self.uniprot_id, self.recommended_name_long)

Hervé  MENAGER's avatar
Hervé MENAGER committed
196

197
class Domain(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
198
199
200
    """
    Domain (i.e. Protein domain) information (from PFAM) 
    """
Hervé  MENAGER's avatar
Hervé MENAGER committed
201
202
    pfam_acc = models.CharField('Pfam Accession', max_length=10, unique=True)
    pfam_id = models.CharField('Pfam Family Identifier', max_length=20)
Hervé  MENAGER's avatar
Hervé MENAGER committed
203
    pfam_description = models.CharField('Pfam Description', max_length=100)
Hervé  MENAGER's avatar
Hervé MENAGER committed
204
    domain_family = models.CharField('Domain family', max_length=25)
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
205

Hervé  MENAGER's avatar
Hervé MENAGER committed
206
207
    # TODO: what is this field? check database
    # contents
208

209
    def autofill(self):
Hervé  MENAGER's avatar
Hervé MENAGER committed
210
211
212
213
        """
        fetch information from external services
        (PFAM)
        """
214
215
216
        info = get_pfam_info(self.pfam_acc)
        self.pfam_id = info['id']
        self.pfam_description = info['description']
Hervé  MENAGER's avatar
Hervé MENAGER committed
217

218
219
220
221
    @property
    def name(self):
        return self.pfam_id

222
223
224
    def __str__(self):
        return '{} ({}-{})'.format(self.pfam_acc, self.pfam_id, self.pfam_description)

Hervé  MENAGER's avatar
Hervé MENAGER committed
225

226
class ProteinDomainComplex(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
227
    """
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
228
    Protein-Domain association
Hervé  MENAGER's avatar
Hervé MENAGER committed
229
    """
230
231
    protein = models.ForeignKey('Protein', models.CASCADE)
    domain = models.ForeignKey('Domain', models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
232
233
234
    ppc_copy_nb = models.IntegerField(
        'Number of copies of the protein in the complex')

Hervé  MENAGER's avatar
Hervé MENAGER committed
235
236
    class Meta:
        verbose_name_plural = "complexes"
237

238
239
240
    def __str__(self):
        return '{}-{}'.format(self.protein_id, self.domain_id)

241
242
    def name(self):
        return self.protein.short_name
Hervé  MENAGER's avatar
Hervé MENAGER committed
243

244

245
class ProteinDomainBoundComplex(ProteinDomainComplex):
Hervé  MENAGER's avatar
Hervé MENAGER committed
246
247
248
    """
    Protein-Domain association with a "bound complex" role
    """
Hervé  MENAGER's avatar
Hervé MENAGER committed
249
250
251
    ppp_copy_nb_per_p = models.IntegerField(
        'Number of copies of the protein in the pocket')

252
253
    class Meta:
        verbose_name_plural = "bound complexes"
Hervé  MENAGER's avatar
Hervé MENAGER committed
254
255


256
class ProteinDomainPartnerComplex(ProteinDomainComplex):
Hervé  MENAGER's avatar
Hervé MENAGER committed
257
258
259
    """
    Protein-Domain association with a "partner complex" role
    """
Hervé  MENAGER's avatar
Hervé MENAGER committed
260

261
262
    class Meta:
        verbose_name_plural = "partner complexes"
Hervé  MENAGER's avatar
Hervé MENAGER committed
263

Hervé  MENAGER's avatar
Hervé MENAGER committed
264

265
class Symmetry(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
266
267
268
    """
    Symmetry of a PPI
    """
269
270
    code = models.CharField('Symmetry code', max_length=2)
    description = models.CharField('Description', max_length=300)
Hervé  MENAGER's avatar
Hervé MENAGER committed
271

272
273
274
    class Meta:
        verbose_name_plural = "symmetries"

275
276
277
    def __str__(self):
        return '{} ({})'.format(self.code, self.description)

278
279

class Disease(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
280
    name = models.CharField('Disease', max_length=30, unique=True)
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
281

Hervé  MENAGER's avatar
Hervé MENAGER committed
282
    # is there any database/nomenclature for diseases?
283
284
285
286

    def __str__(self):
        return self.name

Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
287

Hervé  MENAGER's avatar
Hervé MENAGER committed
288
class PpiFamily(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
289
290
291
    """
    PPI Family
    """
Hervé  MENAGER's avatar
Hervé MENAGER committed
292
293
    name = models.CharField('Name', max_length=30, unique=True)

294
295
296
    class Meta:
        verbose_name_plural = "PPI Families"

Hervé  MENAGER's avatar
Hervé MENAGER committed
297
298
    def __str__(self):
        return self.name
Hervé  MENAGER's avatar
Hervé MENAGER committed
299

Hervé  MENAGER's avatar
Hervé MENAGER committed
300

301
class Ppi(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
302
303
304
    """
    PPI
    """
305
    pdb_id = models.CharField('PDB ID', max_length=4, null=True, blank=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
306
307
    pockets_nb = models.IntegerField(
        'Total number of pockets in the complex', default=1)
308
    symmetry = models.ForeignKey(Symmetry, models.CASCADE)
309
    diseases = models.ManyToManyField(Disease)
310
    family = models.ForeignKey(PpiFamily, models.CASCADE, null=True, blank=True)
311
    name = models.TextField('PPI name', null=True, blank=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
312

313
    def __str__(self):
314
        return 'PPI #{} on {}'.format(self.id, self.name)
315

316
317
318
    def autofill(self):
        # name is denormalized and stored in the database to reduce SQL queries in query mode
        self.name = self.compute_name_from_protein_names()
319
320
321
322
323

    def get_ppi_bound_complexes(self):
        """
        return bound ppi complexes belonging to this ppi
        """
Hervé  MENAGER's avatar
Hervé MENAGER committed
324
        # this is the less efficient query ever seen, FIXME
325
326
        return PpiComplex.objects.filter(ppi=self, complex__in=ProteinDomainBoundComplex.objects.all())

327
    def compute_name_from_protein_names(self):
Hervé  MENAGER's avatar
Hervé MENAGER committed
328
        all_protein_names = set(
329
            [ppi_complex.complex.protein.short_name for ppi_complex in self.ppicomplex_set.all()])
Hervé  MENAGER's avatar
Hervé MENAGER committed
330
331
        bound_protein_names = set(
            [ppi_complex.complex.protein.short_name for ppi_complex in self.get_ppi_bound_complexes()])
332
333
334
335
        partner_protein_names = all_protein_names - bound_protein_names
        bound_str = ','.join(bound_protein_names)
        partner_str = ','.join(partner_protein_names)
        name = bound_str
Hervé  MENAGER's avatar
Hervé MENAGER committed
336
        if partner_str != '':
337
338
            name += ' / ' + partner_str
        return name
339

Hervé  MENAGER's avatar
Hervé MENAGER committed
340

Hervé  MENAGER's avatar
Hervé MENAGER committed
341
class PpiComplex(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
342
343
344
    """
    PPI Complex
    """
345
346
    ppi = models.ForeignKey(Ppi, models.CASCADE)
    complex = models.ForeignKey(ProteinDomainComplex, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
347
348
    cc_nb = models.IntegerField(
        'Number of copies of the complex in the PPI', default=1)
Hervé  MENAGER's avatar
Hervé MENAGER committed
349
350
351
352

    class Meta:
        verbose_name_plural = "Ppi complexes"

353
354
355
    def __str__(self):
        return 'PPI {}, Complex {} ({})'.format(self.ppi, self.complex, self.cc_nb)

Hervé  MENAGER's avatar
Hervé MENAGER committed
356

357
class CompoundManager(models.Manager):
Hervé  MENAGER's avatar
Hervé MENAGER committed
358
359
360
361
    """
    CompoundManager adds automatically a number of annotations to the results
    of the database query, used for filters and compound card
    """
362
363

    def get_queryset(self):
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
364
        # @formatter:off
365
        qs = super().get_queryset()
366
        # with number of publications
367
        qs = qs.annotate(pubs=Count('refcompoundbiblio', distinct=True))
368
        # with best activity
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
369
        qs = qs.annotate(best_activity=Max('compoundactivityresult__activity'))
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
        # with LE
        qs = qs.annotate(le=Cast(1.37 * Max('compoundactivityresult__activity') / F('nb_atom_non_h'), FloatField()))
        # with LLE
        qs = qs.annotate(lle=Cast(Max('compoundactivityresult__activity') - F('a_log_p'), FloatField()))
        # Lipinsky MW (<=500)
        qs = qs.annotate(lipinsky_mw=Case(When(molecular_weight__lte=500, then=True), default=False, output_field=BooleanField()))
        # Lipinsky hba (<=10)
        qs = qs.annotate(lipinsky_hba=Case(When(nb_acceptor_h__lte=10, then=True), default=False, output_field=BooleanField()))
        # Lipinsky hbd (<5)
        qs = qs.annotate(lipinsky_hbd=Case(When(nb_donor_h__lte=5, then=True), default=False, output_field=BooleanField()))
        # Lipinsky a_log_p (<5)
        qs = qs.annotate(lipinsky_a_log_p=Case(When(a_log_p__lte=5, then=True), default=False, output_field=BooleanField()))
        # Lipinsky global
        qs = qs.annotate(lipinsky_score=Cast(F('lipinsky_mw'), IntegerField())+Cast(F('lipinsky_hba'), IntegerField())+ \
            Cast(F('lipinsky_hbd'), IntegerField()) + Cast(F('lipinsky_a_log_p'), IntegerField()))
        qs = qs.annotate(lipinsky=Case(When(lipinsky_score__gte=3, then=True), default=False, output_field=BooleanField()))
        # Veber hba_hbd (<=12)
        qs = qs.annotate(hba_hbd=F('nb_acceptor_h')+F('nb_donor_h'))
        qs = qs.annotate(veber_hba_hbd=Case(When(hba_hbd__lte=12, then=True), default=False, output_field=BooleanField()))
        # Veber TPSA (<=140)
        qs = qs.annotate(veber_tpsa=Case(When(tpsa__lte=140, then=True), default=False, output_field=BooleanField()))
        # Veber Rotatable Bonds (<=10)
        qs = qs.annotate(veber_rb=Case(When(nb_rotatable_bonds__lte=10, then=True), default=False, output_field=BooleanField()))
        # Veber global (Rotatable bonds and (hba_hbd or tpsa))
394
395
        #qs = qs.annotate(veber=F('veber_rb').bitand(F('veber_hba_hbd').bitor(F('veber_tpsa'))))
        qs = qs.annotate(veber=Case(When(Q(Q(nb_rotatable_bonds__lte=10) & (Q(hba_hbd__lte=12) | Q(tpsa__lte=140))), then=True), default=False, output_field=BooleanField()))
396
397
398
399
400
        # Pfizer AlogP (<=3)
        qs = qs.annotate(pfizer_a_log_p=Case(When(a_log_p__lte=3, then=True), default=False, output_field=BooleanField()))
        # Pfizer TPSA (>=75)
        qs = qs.annotate(pfizer_tpsa=Case(When(tpsa__gte=75, then=True), default=False, output_field=BooleanField()))
        # Pfizer global (AlogP and TPSA)
401
402
        #qs = qs.annotate(pfizer=F('pfizer_a_log_p').bitand(F('pfizer_tpsa')))
        qs = qs.annotate(pfizer=Case(When(Q(Q(a_log_p__lte=3) & Q(tpsa__gte=75)), then=True), default=False, output_field=BooleanField()))
403
        # PDB ligand available
404
        qs = qs.annotate(pdb_ligand_av=Cast(Max(Case(When(compoundaction__ligand_id__isnull=False, then=1), default=0, output_field=IntegerField())), BooleanField()))
405
406
407
408
409
410
        # inhibition role
        qs = qs.annotate(inhibition_role=Case(When(compoundactivityresult__modulation_type='I', then=True), default=False, output_field=BooleanField()))
        # binding role
        qs = qs.annotate(binding_role=Case(When(compoundactivityresult__modulation_type='B', then=True), default=False, output_field=BooleanField()))
        # stabilisation role
        qs = qs.annotate(stabilisation_role=Case(When(compoundactivityresult__modulation_type='S', then=True), default=False, output_field=BooleanField()))
411
        # cellular tests performed
412
        qs = qs.annotate(celltest_av=Cast(Max(Case(When(compoundactivityresult__test_activity_description__test_type='CELL', then=1), default=0, output_field=IntegerField())), BooleanField()))
413
        # inhibition tests performed
414
        qs = qs.annotate(inhitest_av=Cast(Max(Case(When(compoundactivityresult__test_activity_description__test_modulation_type='I', then=1), default=0, output_field=IntegerField())), BooleanField()))
415
        # stabilisation tests performed
416
        qs = qs.annotate(stabtest_av=Cast(Max(Case(When(compoundactivityresult__test_activity_description__test_modulation_type='S', then=1), default=0, output_field=IntegerField())), BooleanField()))
417
        # binding tests performed
418
        qs = qs.annotate(bindtest_av=Cast(Max(Case(When(compoundactivityresult__test_activity_description__test_modulation_type='B', then=1), default=0, output_field=IntegerField())), BooleanField()))
419
        # pharmacokinetic tests performed
420
        qs = qs.annotate(pktest_av=Cast(Max(Case(When(refcompoundbiblio__bibliography__pharmacokinetic=True, then=1), default=0, output_field=IntegerField())), BooleanField()))
421
        # cytotoxicity tests performedudy
422
        qs = qs.annotate(cytoxtest_av=Cast(Max(Case(When(refcompoundbiblio__bibliography__cytotox=True, then=1), default=0, output_field=IntegerField())), BooleanField()))
423
        # in silico st performed
424
        qs = qs.annotate(insilico_av=Cast(Max(Case(When(refcompoundbiblio__bibliography__in_silico=True, then=1), default=0, output_field=IntegerField())), BooleanField()))
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
425
        #@formatter:on
426
427
        return qs

Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
428

429
class Compound(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
430
431
432
    """
    Chemical compound
    """
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
433
    objects = CompoundManager()
434
435
    canonical_smile = models.TextField(
        'Canonical Smile', unique=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
436
437
438
439
440
    is_macrocycle = models.BooleanField('Contains one or more macrocycles')
    aromatic_ratio = models.DecimalField(
        'Aromatic ratio', max_digits=3, decimal_places=2)
    balaban_index = models.DecimalField(
        'Balaban index', max_digits=3, decimal_places=2)
441
    fsp3 = models.DecimalField('Fsp3', max_digits=3, decimal_places=2)
Hervé  MENAGER's avatar
Hervé MENAGER committed
442
443
444
445
446
447
448
449
450
451
    gc_molar_refractivity = models.DecimalField(
        'GC Molar Refractivity', max_digits=5, decimal_places=2)
    log_d = models.DecimalField(
        'LogD (Partition coefficient octanol-1/water, with pKa information)', max_digits=4, decimal_places=2)
    a_log_p = models.DecimalField(
        'ALogP (Partition coefficient octanol-1/water)', max_digits=4, decimal_places=2)
    mean_atom_vol_vdw = models.DecimalField(
        'Mean atom volume computed with VdW radii', max_digits=4, decimal_places=2)
    molecular_weight = models.DecimalField(
        'Molecular weight', max_digits=6, decimal_places=2)
452
453
454
455
    nb_acceptor_h = models.IntegerField('Number of hydrogen bond acceptors')
    nb_aliphatic_amines = models.IntegerField('Number of aliphatics amines')
    nb_aromatic_bonds = models.IntegerField('Number of aromatic bonds')
    nb_aromatic_ether = models.IntegerField('Number of aromatic ethers')
Hervé  MENAGER's avatar
Hervé MENAGER committed
456
457
458
459
    nb_aromatic_sssr = models.IntegerField(
        'Number of aromatic Smallest Set of System Rings (SSSR)')
    nb_atom = models.IntegerField('Number of atoms')
    nb_atom_non_h = models.IntegerField('Number of non hydrogen atoms')
460
461
    nb_benzene_like_rings = models.IntegerField('Number of benzene-like rings')
    nb_bonds = models.IntegerField('Number of bonds')
Hervé  MENAGER's avatar
Hervé MENAGER committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
    nb_bonds_non_h = models.IntegerField(
        'Number of bonds not involving a hydrogen')
    nb_br = models.IntegerField('Number of Bromine atoms')
    nb_c = models.IntegerField('Number of Carbon atoms')
    nb_chiral_centers = models.IntegerField('Number of chiral centers')
    nb_circuits = models.IntegerField('Number of circuits')
    nb_cl = models.IntegerField('Number of Chlorine atoms')
    nb_csp2 = models.IntegerField('Number of sp2-hybridized carbon atoms')
    nb_csp3 = models.IntegerField('Number of sp3-hybridized carbon atoms')
    nb_donor_h = models.IntegerField('Number of hydrogen bond donors')
    nb_double_bonds = models.IntegerField('Number of double bonds')
    nb_f = models.IntegerField('Number of fluorine atoms')
    nb_i = models.IntegerField('Number of iodine atoms')
    nb_multiple_bonds = models.IntegerField('Number of multiple bonds')
476
    nb_n = models.IntegerField('Number of nitrogen atoms')
Hervé  MENAGER's avatar
Hervé MENAGER committed
477
478
479
    nb_o = models.IntegerField('Number of oxygen atoms')
    nb_rings = models.IntegerField('Number of rings')
    nb_rotatable_bonds = models.IntegerField('Number of rotatable bonds')
480
481
    inchi = models.TextField('InChi')
    inchikey = models.TextField('InChiKey')
Hervé  MENAGER's avatar
Hervé MENAGER committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
    randic_index = models.DecimalField(
        'Randic index', max_digits=4, decimal_places=2)
    rdf070m = models.DecimalField(
        'RDF070m, radial distribution function weighted by the atomic masses at 7Å', max_digits=5, decimal_places=2)
    rotatable_bond_fraction = models.DecimalField(
        'Fraction of rotatable bonds', max_digits=3, decimal_places=2)
    sum_atom_polar = models.DecimalField(
        'Sum of atomic polarizabilities', max_digits=5, decimal_places=2)
    sum_atom_vol_vdw = models.DecimalField(
        'Sum of atom volumes computed with VdW radii', max_digits=6, decimal_places=2)
    tpsa = models.DecimalField(
        'Topological Polar Surface Area (TPSA)', max_digits=5, decimal_places=2)
    ui = models.DecimalField(
        'Unsaturation index', max_digits=4, decimal_places=2)
    wiener_index = models.IntegerField('Wiener index')
    common_name = models.CharField(
        'Common name', unique=True, max_length=20, blank=True, null=True)
    pubchem_id = models.CharField(
        'Pubchem ID', max_length=10, blank=True, null=True)
    chemspider_id = models.CharField(
        'Chemspider ID', unique=True, max_length=10, blank=True, null=True)
    chembl_id = models.CharField(
        'Chembl ID', max_length=30, blank=True, null=True)
    iupac_name = models.CharField(
        'IUPAC name', max_length=255, blank=True, null=True)
507

508
    class Meta:
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
509
        ordering = ['id']
510

511
512
513
    def compute_drugbank_compound_similarity(self):
        """ compute Tanimoto similarity to existing DrugBank compounds """
        self.save()
514
        # fingerprints to compute drugbank similarities are in settings module, default FP2
515
        fingerprinter = FingerPrinter(getattr(settings, "DRUGBANK_FINGERPRINTS", "FP2"))
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
516
517
        # 1. compute tanimoto for SMILES query vs all compounds
        smiles_dict = {c.id: c.canonical_smiles for c in DrugBankCompound.objects.all()}
518
519
520
521
        tanimoto_dict = fingerprinter.tanimoto_smiles(self.canonical_smile, smiles_dict)
        tanimoto_dict = dict(sorted(tanimoto_dict.items(), key=operator.itemgetter(1), reverse=True)[:15])
        dbcts = []
        for id_, tanimoto in tanimoto_dict.items():
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
522
523
524
525
526
            dbcts.append(DrugbankCompoundTanimoto(
                compound=self,
                drugbank_compound=DrugBankCompound.objects.get(id=id_),
                tanimoto=tanimoto,
            ))
527
528
        DrugbankCompoundTanimoto.objects.bulk_create(dbcts)

Hervé  MENAGER's avatar
Hervé MENAGER committed
529
530
531
    @property
    def biblio_refs(self):
        """
Hervé  MENAGER's avatar
Hervé MENAGER committed
532
        return all RefCompoundBiblio related to this compound
Hervé  MENAGER's avatar
Hervé MENAGER committed
533
534
        """
        return RefCompoundBiblio.objects.filter(compound=self)
535

536
537
538
539
540
541
542
543
544
545
546
547
548
    @property
    def pfam_ids(self):
        """
        return all PFAM ids for the domain of the proteins of the bound
        complexes in the PPIs this compound has an action on
        """
        pfam_ids = set()
        for ca in self.compoundaction_set.all():
            ca.get_complexes()
            for bound_complex in ca.ppi.get_ppi_bound_complexes():
                pfam_ids.add(bound_complex.complex.domain.pfam_id)
        return pfam_ids

549
    @property
Hervé  MENAGER's avatar
Hervé MENAGER committed
550
    def compound_action_ligand_ids(self):
551
552
553
        """
        return all PDB codes of the corresponding compound actions
        """
Hervé  MENAGER's avatar
Hervé MENAGER committed
554
        ligand_ids = set()
555
        for ca in self.compoundaction_set.all():
Hervé  MENAGER's avatar
Hervé MENAGER committed
556
557
            ligand_ids.add(ca.ligand_id)
        return ligand_ids
558

559
560
    @property
    def best_pXC50_activity(self):
561
        return self.compoundactivityresult_set.aggregate(Max('activity'))['activity__max']
562
563
564
565
566
567

    @property
    def best_pXC50_compound_activity_result(self):
        best_pXC50_activity = self.best_pXC50_activity
        if best_pXC50_activity is None:
            return None
568
        return self.compoundactivityresult_set.filter(activity=best_pXC50_activity)[0]
569

570
    @property
571
    def best_pXC50_activity_ppi_name(self):
572
        """
573
        Name of the PPI corresponding to the best PXC50 activity
574
        """
575
576
577
        best_activity_car = self.best_pXC50_compound_activity_result
        if best_activity_car is None:
            return None
578
579
580
        ppi_name = best_activity_car.test_activity_description.ppi.name
        return ppi_name

581
582
583
584
585
586
587
588
589
590
591
    @property
    def best_pXC50_activity_ppi_family(self):
        """
        Family of the PPI corresponding to the best PXC50 activity
        """
        best_activity_car = self.best_pXC50_compound_activity_result
        if best_activity_car is None:
            return None
        ppi_family = best_activity_car.test_activity_description.ppi.family.name
        return ppi_family

592
593
594
595
596
597
598
599
600
601
602
603
604
605
    @property
    def bioch_tests_count(self):
        """
        return the number of associated biochemical tests
        """
        return self.compoundactivityresult_set.all().filter(test_activity_description__test_type='BIOCH').count()

    @property
    def cell_tests_count(self):
        """
        return the number of associated cell tests
        """
        return self.compoundactivityresult_set.all().filter(test_activity_description__test_type='CELL').count()

606
607
608
609
610
611
    @property
    def families(self):
        """
        return the all PPI families for PPIs involved in the compound activity of the compound
        """
        return list(set([ca.ppi.family for ca in self.compoundaction_set.all()]))
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
612

613
614
615
    @property
    def sorted_similar_drugbank_compounds(self):
        return self.drugbankcompoundtanimoto_set.order_by('-tanimoto')
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
616

617
618
619
    def autofill(self):
        # compute InChi and InChiKey
        self.inchi = smi2inchi(self.canonical_smile)
620
        self.inchikey = smi2inchikey(self.canonical_smile)
621
        self.compute_drugbank_compound_similarity()
622

623
624
625
    def __str__(self):
        return 'Compound #{}'.format(self.id)

Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
626

627
628
629
class CompoundTanimoto(models.Model):
    canonical_smiles = models.TextField(
        'Canonical Smile')
630
    fingerprint = models.TextField('Fingerprint')
631
632
633
634
635
636
    compound = models.ForeignKey(Compound, models.CASCADE)
    tanimoto = models.DecimalField(
        'Tanimoto value', max_digits=5, decimal_places=4)

    class Meta:
        unique_together = (
637
            ('canonical_smiles', 'fingerprint', 'compound'))
638

Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
639

640
def create_tanimoto(smiles_query, fingerprint):
Hervé  MENAGER's avatar
Hervé MENAGER committed
641
642
643
644
    """
    Compute the Tanimoto similarity between a given SMILES and the compounds
    then insert the results in CompoundTanimoto
    """
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
645
646
    if CompoundTanimoto.objects.filter(canonical_smiles=smiles_query, fingerprint=fingerprint).count() == 0:
        smiles_dict = {c.id: c.canonical_smile for c in Compound.objects.all()}
647
        fingerprinter = FingerPrinter(fingerprint)
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
648
        # 1. compute tanimoto for SMILES query vs all compounds
649
        tanimoto_dict = fingerprinter.tanimoto_smiles(smiles_query, smiles_dict)
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
650
        # 2. insert results in a table with three fields: SMILES query, compound id, tanimoto index
651
652
        cts = []
        for id_, smiles in smiles_dict.items():
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
653
654
            cts.append(CompoundTanimoto(canonical_smiles=smiles_query, fingerprint=fingerprint,
                                        compound=Compound.objects.get(id=id_), tanimoto=tanimoto_dict[id_]))
655
        CompoundTanimoto.objects.bulk_create(cts)
656

Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
657

658
class PcaBiplotData(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
659
660
661
662
    """
    PCA biplot data
    the table contains all the data as one JSON text in one row
    """
663
664
    pca_biplot_data = models.TextField(
        'PCA biplot JSON data', blank=True, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
665

666

667
class LeLleBiplotData(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
668
669
670
671
    """
    LE-LLE biplot data
    the table contains all the data as one JSON text in one row
    """
672
673
    le_lle_biplot_data = models.TextField(
        'LE-LLE biplot JSON data', blank=True, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
674

675

676
class CellLine(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
677
678
679
    """
    Cell lines
    """
680
    name = models.CharField('Name', max_length=50, unique=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
681

682
683
684
    def __str__(self):
        return self.name

Hervé  MENAGER's avatar
Hervé MENAGER committed
685

686
class TestActivityDescription(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
687
688
689
    """
    Activity test descriptions
    """
690
691
692
693
694
695
696
697
698
    TEST_TYPES = (
        ('BIOCH', 'Biochemical assay'),
        ('CELL', 'Cellular assay')
    )
    TEST_MODULATION_TYPES = (
        ('B', 'Binding'),
        ('I', 'Inhibition'),
        ('S', 'Stabilization')
    )
699
700
701
702
    PROTEIN_BOUND_CONSTRUCTS = (
        ('F', 'Full length'),
        ('U', 'Unspecified')
    )
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
703
704
705
706
    biblio = models.ForeignKey(
        Bibliography,
        on_delete=models.CASCADE,
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
707
    protein_domain_bound_complex = models.ForeignKey(
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
708
709
710
        ProteinDomainBoundComplex,
        on_delete=models.CASCADE,
    )
711
    ppi = models.ForeignKey(Ppi, models.CASCADE, blank=True, null=True)
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
712
713
714
715
716
717
718
    test_name = models.CharField(
        verbose_name='Test name',
        max_length=100,
    )
    is_primary = models.BooleanField(
        verbose_name='Is primary',
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
719
    protein_bound_construct = models.CharField(
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
720
721
722
723
724
725
726
727
728
729
730
        verbose_name='Protein bound construct',
        max_length=5,
        choices=PROTEIN_BOUND_CONSTRUCTS,
        blank=True,
        null=True,
    )
    test_type = models.CharField(
        verbose_name='Test type',
        max_length=5,
        choices=TEST_TYPES,
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
731
    test_modulation_type = models.CharField(
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
732
733
734
735
        verbose_name='Test modulation type',
        max_length=1,
        choices=TEST_MODULATION_TYPES,
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
736
    nb_active_compounds = models.IntegerField(
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
737
738
        verbose_name='Total number of active compounds',
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
739
    cell_line = models.ForeignKey(
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
740
741
742
743
744
        CellLine,
        on_delete=models.CASCADE,
        blank=True,
        null=True,
    )
745

Hervé  MENAGER's avatar
Hervé MENAGER committed
746
    def get_complexes(self):
747
748
749
750
        """
        get the complexes tested for this PPI
        depends on the modulation type
        """
Hervé  MENAGER's avatar
Hervé MENAGER committed
751
        if self.test_modulation_type == 'I':
752
            return self.ppi.ppicomplex_set.all()
753
754
        else:
            return self.ppi.get_ppi_bound_complexes()
755

756
757
758
    @property
    def protein_domain_partner_complex(self):
        for ppic in self.ppi.ppicomplex_set.all():
Hervé  MENAGER's avatar
Hervé MENAGER committed
759
            if hasattr(ppic.complex, 'proteindomainpartnercomplex'):
760
761
762
                return ppic.complex.proteindomainpartnercomplex
        return None

763
764
765
766
767
768
769
    @property
    def name(self):
        return self.test_name

    def __str__(self):
        return self.get_test_type_display()

Hervé  MENAGER's avatar
Hervé MENAGER committed
770

771
class CompoundActivityResult(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
772
773
774
    """
    Activity test results on a compound
    """
775
776
777
778
    MODULATION_TYPES = (
        ('I', 'Inhibition'),
        ('S', 'Stabilization')
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
779
    ACTIVITY_TYPES = (
Hervé  MENAGER's avatar
Hervé MENAGER committed
780
781
782
783
        ('pIC50', 'pIC50 (half maximal inhibitory concentration, -log10)'),
        ('pEC50', 'pEC50 (half maximal effective concentration, -log10)'),
        ('pKd', 'pKd (dissociation constant, -log10)'),
        ('pKi', 'pKi (inhibition constant, -log10)'),
Hervé  MENAGER's avatar
Hervé MENAGER committed
784
    )
785
    compound = models.ForeignKey(Compound, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
786
787
    test_activity_description = models.ForeignKey(
        TestActivityDescription, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
788
789
790
791
    activity_type = models.CharField(
        'Activity type', max_length=5, choices=ACTIVITY_TYPES)
    activity = models.DecimalField(
        'Activity', max_digits=12, decimal_places=10)
792
    inhibition_percentage = models.DecimalField(
793
        'Inhibition percentage', max_digits=3, decimal_places=0, null=True, blank=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
794
795
    modulation_type = models.CharField(
        'Modulation type', max_length=1, choices=MODULATION_TYPES)
Hervé  MENAGER's avatar
Hervé MENAGER committed
796
797

    class Meta:
Hervé  MENAGER's avatar
Hervé MENAGER committed
798
799
800
        unique_together = (
            ('compound', 'test_activity_description', 'activity_type'),)

801
    def __str__(self):
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
802
803
804
805
806
        return 'Compound activity result for {} test {} on {}'.format(
            self.activity_type,
            self.test_activity_description.id,
            self.compound.id,
        )
Hervé  MENAGER's avatar
Hervé MENAGER committed
807

808
809
810
    def is_best(self):
        return self.compound.best_pXC50_compound_activity_result.id == self.id

Hervé  MENAGER's avatar
Hervé MENAGER committed
811

812
class TestCytotoxDescription(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
813
814
815
    """
    Cytotoxicity test descriptions
    """
816
    biblio = models.ForeignKey(Bibliography, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
817
    test_name = models.CharField('Cytotoxicity test name', max_length=100)
818
    cell_line = models.ForeignKey(CellLine, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
819
820
821
    compound_concentration = models.DecimalField(
        'Compound concentration in μM', max_digits=7, decimal_places=3, blank=True, null=True)

Hervé  MENAGER's avatar
Hervé MENAGER committed
822

823
class CompoundCytotoxicityResult(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
824
825
826
    """
    Cytotoxicity test results on a compound
    """
827
    compound = models.ForeignKey(Compound, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
828
829
    test_cytotoxicity_description = models.ForeignKey(
        TestCytotoxDescription, models.CASCADE)
830
    toxicity = models.BooleanField('Toxicity', default=False)
Hervé  MENAGER's avatar
Hervé MENAGER committed
831
832

    class Meta:
833
        unique_together = (('compound', 'test_cytotoxicity_description'),)
834

835
    def __str__(self):
Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
836
837
838
839
        return 'Compound cytotoxicity result for test {} on {}'.format(
            self.test_cytotoxicity_description.id,
            self.compound.id,
        )
840

Hervé  MENAGER's avatar
Hervé MENAGER committed
841

842
class TestPKDescription(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
843
844
845
    """
    Pharmacokinetic test descriptions
    """
846
847
848
849
850
851
    ADMINISTRATION_MODES = (
        ('IV', ''),
        ('PO', ''),
        ('IP', ''),
        ('SL', 'SL')
    )
852
    biblio = models.ForeignKey(Bibliography, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
853
    test_name = models.CharField('Pharmacokinetic test name', max_length=100)
854
    organism = models.ForeignKey(Taxonomy, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
855
856
    administration_mode = models.CharField(
        'Administration mode', max_length=2, choices=ADMINISTRATION_MODES, blank=True, null=True)
857
858
    concentration = models.DecimalField(
        'Concentration in mg/l', max_digits=7, decimal_places=3, blank=True, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
859
    dose = models.DecimalField(
860
        'Dose in mg/kg', max_digits=9, decimal_places=4, blank=True, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
861
862
863
    dose_interval = models.IntegerField(
        'Dose interval, in hours', blank=True, null=True)

864
865

class CompoundPKResult(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
866
867
868
    """
    Pharmacokinetic test results on a compound
    """
869
870
    compound = models.ForeignKey(Compound, models.CASCADE)
    test_pk_description = models.ForeignKey(TestPKDescription, models.CASCADE)
871
    tolerated = models.NullBooleanField('Tolerated', null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
872
873
874
875
    auc = models.IntegerField(
        'Area under curve (ng.mL-1.hr)', blank=True, null=True)
    clearance = models.DecimalField(
        'Clearance (mL/hr)', max_digits=7, decimal_places=3, blank=True, null=True)
876
    c_max = models.DecimalField(
Hervé  MENAGER's avatar
Hervé MENAGER committed
877
878
879
880
881
882
883
        'Maximal concentration (ng/mL)', max_digits=7, decimal_places=3, blank=True, null=True)
    oral_bioavailability = models.IntegerField(
        'Oral Bioavailability (%F)', blank=True, null=True)
    t_demi = models.IntegerField('t½', blank=True, null=True)
    t_max = models.IntegerField('tmax', blank=True, null=True)
    voldistribution = models.DecimalField(
        'Volume distribution (Vd)', max_digits=5, decimal_places=2, blank=True, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
884
885

    class Meta:
886
        unique_together = (('compound', 'test_pk_description'),)
Hervé  MENAGER's avatar
Hervé MENAGER committed
887

888
889
890
    def __str__(self):
        return 'Compound PK result for test {} on {}'.format(self.test_pk_description.id, self.compound.id)

Hervé  MENAGER's avatar
Hervé MENAGER committed
891

892
class CompoundAction(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
893
894
895
    """
    Compound action
    """
896
897
    ACTIVATION_MODES = (
        ('O', 'Orthosteric'),
898
899
        ('A', 'Allosteric'),
        ('U', 'Unspecified')
900
    )
901
    compound = models.ForeignKey(Compound, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
902
903
    activation_mode = models.CharField(
        'Activation mode', max_length=1, choices=ACTIVATION_MODES)
904
    ppi = models.ForeignKey(Ppi, models.CASCADE)
905
    ligand_id = models.CharField('PDB Ligand ID', max_length=3, blank=True, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
906
907
    nb_copy_compounds = models.IntegerField(
        'Number of copies for the compound')
Hervé  MENAGER's avatar
Hervé MENAGER committed
908
909

    class Meta:
910
        unique_together = (('ppi', 'compound', 'activation_mode', 'ligand_id'),)
Hervé  MENAGER's avatar
Hervé MENAGER committed
911
912

    def get_complexes(self):
913
914
915
916
        """
        get the complexes involved in the compound action
        which are always the bound complexes
        """
917
        return self.ppi.get_ppi_bound_complexes()
Hervé  MENAGER's avatar
Hervé MENAGER committed
918

919
920
    def __str__(self):
        return 'Action of {} on {}'.format(self.compound, self.ppi)
Hervé  MENAGER's avatar
Hervé MENAGER committed
921

Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
922

923
class RefCompoundBiblio(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
924
925
926
    """
    Compound-Bibliographic reference association
    """
927
928
    compound = models.ForeignKey(Compound, models.CASCADE)
    bibliography = models.ForeignKey(Bibliography, models.CASCADE)
Hervé  MENAGER's avatar
Hervé MENAGER committed
929
930
    compound_name = models.CharField(
        'Compound name in the publication', max_length=50)
Hervé  MENAGER's avatar
Hervé MENAGER committed
931
932

    class Meta:
933
        unique_together = (('compound', 'bibliography'),)
934

Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
935

936
class DrugBankCompound(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
937
938
939
    """
    Drugbank compound
    """
940
941
942
943
944
    id = models.TextField(
        'Drugbank ID', unique=True, primary_key=True)
    common_name = models.TextField('Common name')
    canonical_smiles = models.TextField(
        'Canonical SMILES')
945

Bryan  BRANCOTTE's avatar
Bryan BRANCOTTE committed
946

947
class DrugbankCompoundTanimoto(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
948
949
950
    """
    Drugbank compound-compound tanimoto similarity
    """