models.py 20.7 KB
Newer Older
Hervé  MENAGER's avatar
Hervé MENAGER committed
1
2
3
4
from __future__ import unicode_literals

from django.db import models

5
from .ws import get_pubmed_info, get_epo_info, get_uniprot_info, get_taxonomy_info, get_go_info, get_pfam_info
6

Hervé  MENAGER's avatar
Hervé MENAGER committed
7

8
class AutoFillableModel(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
9

10
11
12
13
14
15
16
17
18
19
20
21
22
    """
    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()
23
24
        if 'autofill' in kwargs:
            del kwargs['autofill']
Hervé  MENAGER's avatar
Hervé MENAGER committed
25
        super(AutoFillableModel, self).save(*args, **kwargs)
26
27
28


class Bibliography(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
29

Hervé  MENAGER's avatar
Hervé MENAGER committed
30
31
32
33
    """
    Bibliography data table
    """
    SOURCES = (
34
35
36
        ('PM', 'PubMed ID'),
        ('PT', 'Patent'),
        ('DO', 'DOI ID')
Hervé  MENAGER's avatar
Hervé MENAGER committed
37
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
38
39
    source = models.CharField(
        'Bibliographic type', max_length=2, choices=SOURCES, default='PM')
Hervé  MENAGER's avatar
Hervé MENAGER committed
40
41
    id_source = models.CharField('Bibliographic ID', max_length=25)
    title = models.CharField('Title', max_length=300)
42
    journal_name = models.CharField('Journal name', max_length=50, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
43
44
    authors_list = models.CharField('Authors list', max_length=500)
    biblio_year = models.PositiveSmallIntegerField('Year')
45
    cytotox = models.BooleanField('Cytotoxicity data', default=False)
Rachel TORCHET's avatar
Rachel TORCHET committed
46
47
48
49
    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
50
51
    pharmacokinetic = models.BooleanField(
        'pharmacokinetic study', default=False)
Rachel TORCHET's avatar
Rachel TORCHET committed
52
    xray = models.BooleanField('X-Ray data', default=False)
Hervé  MENAGER's avatar
Hervé MENAGER committed
53

54
    def autofill(self):
55
56
57
58
59
60
61
62
        if self.source == 'PM':
            info = get_pubmed_info(self.id_source)
        else:
            info = get_epo_info(self.id_source)
        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
63

Hervé  MENAGER's avatar
Hervé MENAGER committed
64
65
66
    class Meta:
        verbose_name_plural = "bibliographies"

67
68
    def __str__(self):
        return '{}, {}'.format(self.source, self.id_source)
69

Hervé  MENAGER's avatar
Hervé MENAGER committed
70

71
class Taxonomy(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
72
73
    taxonomy_id = models.DecimalField(
        'NCBI TaxID', unique=True, max_digits=9, decimal_places=0)
Hervé  MENAGER's avatar
Hervé MENAGER committed
74
    name = models.CharField('Organism name', max_length=200)
75

76
    def autofill(self):
77
78
79
        info = get_taxonomy_info(self.taxonomy_id)
        self.name = info['scientific_name']

80
81
82
    def __str__(self):
        return self.name

Hervé  MENAGER's avatar
Hervé MENAGER committed
83
84
    class Meta:
        verbose_name_plural = "taxonomies"
Hervé  MENAGER's avatar
Hervé MENAGER committed
85

Hervé  MENAGER's avatar
Hervé MENAGER committed
86

87
class MolecularFunction(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
88
89
    go_id = models.CharField('Gene Ontology ID', unique=True, max_length=10)
                             # GO term id format: 'GO:0000000'
Hervé  MENAGER's avatar
Hervé MENAGER committed
90
91
    description = models.CharField('description', max_length=500)

92
    def autofill(self):
93
94
95
        info = get_go_info(self.go_id)
        self.description = info['label']

96
97
98
    def __str__(self):
        return self.description

Hervé  MENAGER's avatar
Hervé MENAGER committed
99

100
class Protein(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
101
    uniprot_id = models.CharField('Uniprot ID', unique=True, max_length=10)
Hervé  MENAGER's avatar
Hervé MENAGER committed
102
103
    recommended_name_long = models.CharField(
        'Uniprot Recommended Name (long)', max_length=75)
Hervé  MENAGER's avatar
Hervé MENAGER committed
104
105
106
    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)
107
    organism = models.ForeignKey('Taxonomy', default='Homo sapiens')
Hervé  MENAGER's avatar
Hervé MENAGER committed
108
109
    molecular_functions = models.ManyToManyField(MolecularFunction)

110
    def autofill(self):
111
        info = get_uniprot_info(self.uniprot_id)
112
        self.recommended_name_long = info['recommended_name']
113
114
        self.gene_name = info['gene']
        self.entry_name = info['entry_name']
115
        self.short_name = info['short_name']
116
117
118
119
120
        try:
            taxonomy = Taxonomy.objects.get(taxonomy_id=info['organism'])
        except Taxonomy.DoesNotExist:
            taxonomy = Taxonomy()
            taxonomy.taxonomy_id = info['organism']
121
            taxonomy.save(autofill=True)
122
        self.organism = taxonomy
123
        super(Protein, self).save()
124
125
126
127
128
129
        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
130
                mol_function.save(autofill=True)
131
            self.molecular_functions.add(mol_function)
132

133
134
135
    def __str__(self):
        return '{} ({})'.format(self.uniprot_id, self.recommended_name_long)

Hervé  MENAGER's avatar
Hervé MENAGER committed
136

137
class Domain(AutoFillableModel):
Hervé  MENAGER's avatar
Hervé MENAGER committed
138
139
    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
140
    pfam_description = models.CharField('Pfam Description', max_length=100)
Hervé  MENAGER's avatar
Hervé MENAGER committed
141
142
143
    domain_family = models.CharField('Domain family', max_length=25)
                                     # TODO: what is this field? check database
                                     # contents
144

145
    def autofill(self):
146
147
148
        info = get_pfam_info(self.pfam_acc)
        self.pfam_id = info['id']
        self.pfam_description = info['description']
Hervé  MENAGER's avatar
Hervé MENAGER committed
149

150
151
152
    def __str__(self):
        return '{} ({}-{})'.format(self.pfam_acc, self.pfam_id, self.pfam_description)

Hervé  MENAGER's avatar
Hervé MENAGER committed
153

154
class ProteinDomainComplex(models.Model):
155
156
    protein = models.ForeignKey('Protein')
    domain = models.ForeignKey('Domain')
Hervé  MENAGER's avatar
Hervé MENAGER committed
157
158
159
    ppc_copy_nb = models.IntegerField(
        'Number of copies of the protein in the complex')

Hervé  MENAGER's avatar
Hervé MENAGER committed
160
161
    class Meta:
        verbose_name_plural = "complexes"
162

163
164
165
    def __str__(self):
        return '{}-{}'.format(self.protein_id, self.domain_id)

Hervé  MENAGER's avatar
Hervé MENAGER committed
166

167
class ProteinDomainBoundComplex(ProteinDomainComplex):
Hervé  MENAGER's avatar
Hervé MENAGER committed
168
169
170
    ppp_copy_nb_per_p = models.IntegerField(
        'Number of copies of the protein in the pocket')

171
172
    class Meta:
        verbose_name_plural = "bound complexes"
Hervé  MENAGER's avatar
Hervé MENAGER committed
173
174


175
class ProteinDomainPartnerComplex(ProteinDomainComplex):
Hervé  MENAGER's avatar
Hervé MENAGER committed
176

177
178
    class Meta:
        verbose_name_plural = "partner complexes"
Hervé  MENAGER's avatar
Hervé MENAGER committed
179

Hervé  MENAGER's avatar
Hervé MENAGER committed
180

181
182
183
class Symmetry(models.Model):
    code = models.CharField('Symmetry code', max_length=2)
    description = models.CharField('Description', max_length=300)
Hervé  MENAGER's avatar
Hervé MENAGER committed
184

185
186
187
    class Meta:
        verbose_name_plural = "symmetries"

188
189
190
    def __str__(self):
        return '{} ({})'.format(self.code, self.description)

191
192

class Disease(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
193
194
    name = models.CharField('Disease', max_length=30, unique=True)
                            # is there any database/nomenclature for diseases?
195
196
197
198

    def __str__(self):
        return self.name

Hervé  MENAGER's avatar
Hervé MENAGER committed
199

200
class Ppi(models.Model):
201
    pdb_id = models.CharField('PDB ID', max_length=4, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
202
203
    pockets_nb = models.IntegerField(
        'Total number of pockets in the complex', default=1)
204
    symmetry = models.ForeignKey(Symmetry)
205
    diseases = models.ManyToManyField(Disease)
Hervé  MENAGER's avatar
Hervé MENAGER committed
206

207
208
209
    def __str__(self):
        return '{} PPI, PDB:{}'.format(self.symmetry.description, self.pdb_id or 'unknown')

210
211
212
213
214
215
216
217
218
219
    def get_ppi_complexes(self):
        """
        return all ppi complexes belonging to this ppi
        """
        return PpiComplex.objects.filter(ppi=self)

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

223
224
225
226
227
228
229
230
231
232
233
    @property
    def name(self):
        all_protein_names = set([ppi_complex.complex.protein.short_name for ppi_complex in self.get_ppi_complexes()])
        bound_protein_names = set([ppi_complex.complex.protein.short_name for ppi_complex in self.get_ppi_bound_complexes()])
        partner_protein_names = all_protein_names - bound_protein_names
        bound_str = ','.join(bound_protein_names)
        partner_str = ','.join(partner_protein_names)
        name = bound_str
        if partner_str!='':
            name += ' / ' + partner_str
        return name
234

Hervé  MENAGER's avatar
Hervé MENAGER committed
235
236
237
class PpiComplex(models.Model):
    ppi = models.ForeignKey(Ppi)
    complex = models.ForeignKey(ProteinDomainComplex)
Hervé  MENAGER's avatar
Hervé MENAGER committed
238
239
    cc_nb = models.IntegerField(
        'Number of copies of the complex in the PPI', default=1)
Hervé  MENAGER's avatar
Hervé MENAGER committed
240
241
242
243

    class Meta:
        verbose_name_plural = "Ppi complexes"

244
245
246
    def __str__(self):
        return 'PPI {}, Complex {} ({})'.format(self.ppi, self.complex, self.cc_nb)

Hervé  MENAGER's avatar
Hervé MENAGER committed
247

248
class Compound(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
249
250
251
252
253
254
255
    canonical_smile = models.CharField(
        'Canonical Smile', unique=True, max_length=500)
    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)
256
    fsp3 = models.DecimalField('Fsp3', max_digits=3, decimal_places=2)
Hervé  MENAGER's avatar
Hervé MENAGER committed
257
258
259
260
261
262
263
264
265
266
    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)
267
268
269
270
    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
271
272
273
274
    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')
275
276
    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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
    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')
291
    nb_n = models.IntegerField('Number of nitrogen atoms')
Hervé  MENAGER's avatar
Hervé MENAGER committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
    nb_o = models.IntegerField('Number of oxygen atoms')
    nb_rings = models.IntegerField('Number of rings')
    nb_rotatable_bonds = models.IntegerField('Number of rotatable bonds')
    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)
    mddr_compound = models.ForeignKey(
        'MDDRCompoundImport', blank=True, null=True)
322

Hervé  MENAGER's avatar
Hervé MENAGER committed
323
324
325
326
327
328
    @property
    def biblio_refs(self):
        """
        return all RefCompoundBiblio related to this complex
        """
        return RefCompoundBiblio.objects.filter(compound=self)
329

330
class MDDRActivityClass(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
331
    name = models.CharField('Activity Class', max_length=100, unique=True)
332
333
334
335
336

    class Meta:
        verbose_name_plural = "MDDR activity classes"

    def __str__(self):
337
        return self.name
338

Hervé  MENAGER's avatar
Hervé MENAGER committed
339

340
class MDDRCompoundImport(models.Model):
341
342

    MDDR_DEVELOPMENT_PHASES = (
Hervé  MENAGER's avatar
Hervé MENAGER committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
        ('Biological Testing', ''),
        ('Preclinical', ''),
        ('Phase III', ''),
        ('Phase II', ''),
        ('Phase I/II', ''),
        ('Phase I', ''),
        ('Launched', ''),
        ('Pre-Registered', ''),
        ('Not Applicable', ''),
        ('Discontinued', ''),
        ('Clinical', ''),
        ('Withdrawn', ''),
        ('Registered', ''),
        ('Not Determined', ''),
        ('Phase II/III', ''),
        ('IND Filed', ''),
359
360
    )

Hervé  MENAGER's avatar
Hervé MENAGER committed
361
362
363
364
365
366
367
    mddr_name = models.CharField('MDDR name', max_length=40)
    dvpmt_phase = models.CharField(
        'Development phase', max_length=20, choices=MDDR_DEVELOPMENT_PHASES)
    canonical_smile = models.CharField(
        'Canonical Smile', max_length=500, blank=True, null=True)
    # TODO index this table on canonical_smile
    db_import_date = models.DateTimeField('MDDR release year/month')
368
    activity_classes = models.ManyToManyField(MDDRActivityClass)
Hervé  MENAGER's avatar
Hervé MENAGER committed
369

370
371
    class Meta:
        # over multiple releases of the MDDR database, the same compound can evolve in its development phase
Hervé  MENAGER's avatar
Hervé MENAGER committed
372
373
        # the same compound can have different names and development phases in
        # the same MDDR release
374
        unique_together = (('mddr_name', 'dvpmt_phase', 'canonical_smile'),)
Hervé  MENAGER's avatar
Hervé MENAGER committed
375
        verbose_name_plural = "MDDR compound imports"
Hervé  MENAGER's avatar
Hervé MENAGER committed
376

377
378
379
    def __str__(self):
        return "{}, {}".format(self.mddr_name, self.dvpmt_phase)

Hervé  MENAGER's avatar
Hervé MENAGER committed
380

381
class MDDRSimilarity(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
382
383
384
385
386
    canonical_smile_ippidb = models.CharField(
        'Canonical Smile for IPPIDB compound', max_length=500, unique=True, blank=True, null=True)
    canonical_smile_mddr = models.CharField(
        'Canonical Smile for MDDR Compound', max_length=500, unique=True, blank=True, null=True)
    tanimoto = models.DecimalField('Tanimoto', max_digits=6, decimal_places=5)
Hervé  MENAGER's avatar
Hervé MENAGER committed
387
388

    class Meta:
389
        unique_together = (('canonical_smile_ippidb', 'canonical_smile_mddr'),)
Hervé  MENAGER's avatar
Hervé MENAGER committed
390
        verbose_name_plural = "MDDR similarities"
391

Hervé  MENAGER's avatar
Hervé MENAGER committed
392

393
394
class CellLine(models.Model):
    name = models.CharField('Name', max_length=50, unique=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
395

396
397
398
    def __str__(self):
        return self.name

Hervé  MENAGER's avatar
Hervé MENAGER committed
399

400
401
402
403
404
405
406
407
408
409
class TestActivityDescription(models.Model):
    TEST_TYPES = (
        ('BIOCH', 'Biochemical assay'),
        ('CELL', 'Cellular assay')
    )
    TEST_MODULATION_TYPES = (
        ('B', 'Binding'),
        ('I', 'Inhibition'),
        ('S', 'Stabilization')
    )
410
    biblio = models.ForeignKey(Bibliography)
Hervé  MENAGER's avatar
Hervé MENAGER committed
411
412
    ppi = models.ForeignKey(Ppi, blank=True, null=True)
    test_name = models.CharField('Test name', max_length=100)
413
    test_type = models.CharField('Test type', max_length=5, choices=TEST_TYPES)
Hervé  MENAGER's avatar
Hervé MENAGER committed
414
415
416
417
    test_modulation_type = models.CharField(
        'Test modulation type', max_length=1, choices=TEST_MODULATION_TYPES)
    nb_active_compounds = models.IntegerField(
        'Total number of active compounds')
418
    cell_line = models.ForeignKey(CellLine, blank=True, null=True)
419

Hervé  MENAGER's avatar
Hervé MENAGER committed
420
    def get_complexes(self):
421
422
423
424
        """
        get the complexes tested for this PPI
        depends on the modulation type
        """
Hervé  MENAGER's avatar
Hervé MENAGER committed
425
        if self.test_modulation_type == 'I':
426
427
428
            return self.ppi.get_ppi_complexes()
        else:
            return self.ppi.get_ppi_bound_complexes()
429

Hervé  MENAGER's avatar
Hervé MENAGER committed
430

431
class CompoundActivityResult(models.Model):
432
433
434
435
436
    MODULATION_TYPES = (
        ('B', 'Binding'),
        ('I', 'Inhibition'),
        ('S', 'Stabilization')
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
437
    ACTIVITY_TYPES = (
Hervé  MENAGER's avatar
Hervé MENAGER committed
438
439
440
441
        ('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
442
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
443
444
445
446
447
448
449
450
    compound = models.ForeignKey(Compound)
    test_activity_description = models.ForeignKey(TestActivityDescription)
    activity_type = models.CharField(
        'Activity type', max_length=5, choices=ACTIVITY_TYPES)
    activity = models.DecimalField(
        'Activity', max_digits=12, decimal_places=10)
    modulation_type = models.CharField(
        'Modulation type', max_length=1, choices=MODULATION_TYPES)
Hervé  MENAGER's avatar
Hervé MENAGER committed
451
452

    class Meta:
Hervé  MENAGER's avatar
Hervé MENAGER committed
453
454
455
        unique_together = (
            ('compound', 'test_activity_description', 'activity_type'),)

Hervé  MENAGER's avatar
Hervé MENAGER committed
456

457
class TestCytotoxDescription(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
458
459
    biblio = models.ForeignKey(Bibliography)
    test_name = models.CharField('Cytotoxicity test name', max_length=100)
460
    cell_line = models.ForeignKey(CellLine)
Hervé  MENAGER's avatar
Hervé MENAGER committed
461
462
463
    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
464

465
class CompoundCytotoxicityResult(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
466
    compound = models.ForeignKey(Compound)
467
    test_cytotoxicity_description = models.ForeignKey(TestCytotoxDescription)
468
    toxicity = models.BooleanField('Toxicity', default=False)
Hervé  MENAGER's avatar
Hervé MENAGER committed
469
470

    class Meta:
471
        unique_together = (('compound', 'test_cytotoxicity_description'),)
472

Hervé  MENAGER's avatar
Hervé MENAGER committed
473

474
class TestPKDescription(models.Model):
475
476
477
478
479
480
    ADMINISTRATION_MODES = (
        ('IV', ''),
        ('PO', ''),
        ('IP', ''),
        ('SL', 'SL')
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
481
482
    biblio = models.ForeignKey(Bibliography)
    test_name = models.CharField('Pharmacokinetic test name', max_length=100)
483
    organism = models.ForeignKey(Taxonomy)
Hervé  MENAGER's avatar
Hervé MENAGER committed
484
485
486
487
488
489
490
    administration_mode = models.CharField(
        'Administration mode', max_length=2, choices=ADMINISTRATION_MODES, blank=True, null=True)
    dose = models.DecimalField(
        'Dose in mg/kg', max_digits=7, decimal_places=4, blank=True, null=True)
    dose_interval = models.IntegerField(
        'Dose interval, in hours', blank=True, null=True)

491
492

class CompoundPKResult(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
493
    compound = models.ForeignKey(Compound)
494
    test_pk_description = models.ForeignKey(TestPKDescription)
495
    tolerated = models.NullBooleanField('Tolerated', null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
496
497
498
499
500
501
502
503
504
505
506
507
    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)
    cmax = models.DecimalField(
        '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
508
509

    class Meta:
510
        unique_together = (('compound', 'test_pk_description'),)
Hervé  MENAGER's avatar
Hervé MENAGER committed
511
512


513
class CompoundAction(models.Model):
514
515
    ACTIVATION_MODES = (
        ('O', 'Orthosteric'),
516
517
        ('A', 'Allosteric'),
        ('U', 'Unspecified')
518
    )
Hervé  MENAGER's avatar
Hervé MENAGER committed
519
520
521
    compound = models.ForeignKey(Compound)
    activation_mode = models.CharField(
        'Activation mode', max_length=1, choices=ACTIVATION_MODES)
522
    ppi = models.ForeignKey(Ppi)
523
    pdb_id = models.CharField('PDB ID', max_length=4, blank=True, null=True)
Hervé  MENAGER's avatar
Hervé MENAGER committed
524
525
    nb_copy_compounds = models.IntegerField(
        'Number of copies for the compound')
Hervé  MENAGER's avatar
Hervé MENAGER committed
526
527

    class Meta:
Hervé  MENAGER's avatar
Hervé MENAGER committed
528
529
530
        unique_together = (('ppi', 'compound', 'activation_mode', 'pdb_id'),)

    def get_complexes(self):
531
532
533
534
        """
        get the complexes involved in the compound action
        which are always the bound complexes
        """
535
        return self.ppi.get_ppi_bound_complexes()
Hervé  MENAGER's avatar
Hervé MENAGER committed
536

Hervé  MENAGER's avatar
Hervé MENAGER committed
537

538
class RefCompoundBiblio(models.Model):
Hervé  MENAGER's avatar
Hervé MENAGER committed
539
540
541
542
    compound = models.ForeignKey(Compound)
    bibliography = models.ForeignKey(Bibliography)
    compound_name = models.CharField(
        'Compound name in the publication', max_length=50)
Hervé  MENAGER's avatar
Hervé MENAGER committed
543
544

    class Meta:
545
        unique_together = (('compound', 'bibliography'),)