Add LibraryType option, (this will probably require a dump/reload)
[htsworkflow.git] / htsworkflow / frontend / samples / models.py
index 8a5c31a85efc83ee500b87b6e7413a14e4794ba0..5b8f6a7da74d9e4631e064ee9f0f093aebb5b2f7 100644 (file)
@@ -1,3 +1,4 @@
+import urlparse
 from django.db import models
 from django.contrib.auth.models import User
 from htsworkflow.frontend import settings
@@ -58,6 +59,12 @@ class Condition(models.Model):
     class Meta:
         ordering = ["condition_name"]
 
+class ExperimentType(models.Model):
+  name = models.CharField(max_length=50, unique=True)
+
+  def __unicode__(self):
+    return unicode(self.name)
+
 class Tag(models.Model): 
   tag_name = models.CharField(max_length=100, db_index=True,blank=False,null=False) 
   TAG_CONTEXT = ( 
@@ -92,8 +99,8 @@ class Species(models.Model):
     ordering = ["scientific_name"]
   
 class Affiliation(models.Model):
-  name = models.CharField(max_length=256, db_index=True, verbose_name='Group Name')
-  contact = models.CharField(max_length=256, null=True, blank=True,verbose_name='Contact Name')  
+  name = models.CharField(max_length=256, db_index=True, verbose_name='Name')
+  contact = models.CharField(max_length=256, null=True, blank=True,verbose_name='Lab Name')  
   email = models.EmailField(null=True,blank=True)
   
   def __unicode__(self):
@@ -106,13 +113,21 @@ class Affiliation(models.Model):
     ordering = ["name","contact"]
     unique_together = (("name", "contact"),)
 
+class LibraryType(models.Model):
+  name = models.CharField(max_length=255, unique=True)
+
+  def __unicode__(self):
+    return unicode(self.name)
+
 class Library(models.Model):
   id = models.AutoField(primary_key=True)
-  library_id = models.CharField(max_length=30, db_index=True)
+  library_id = models.CharField(max_length=30, db_index=True, unique=True)
   library_name = models.CharField(max_length=100, unique=True)
   library_species = models.ForeignKey(Species)
-  cell_line = models.ForeignKey(Cellline)
-  condition = models.ForeignKey(Condition)
+  # new field 2008 Mar 5, alter table samples_library add column "hidden" NOT NULL default 0;
+  hidden = models.BooleanField()
+  cell_line = models.ForeignKey(Cellline, blank=True, null=True, verbose_name="Background")
+  condition = models.ForeignKey(Condition, blank=True, null=True)
   antibody = models.ForeignKey(Antibody,blank=True,null=True)
   # New field Aug/25/08. SQL: alter table fctracker_library add column "lib_affiliation" varchar(256)  NULL;
   affiliations = models.ManyToManyField(Affiliation,related_name='library_affiliations',null=True)
@@ -122,18 +137,8 @@ class Library(models.Model):
   # SQL to add column: alter table fctracker_library add column "replicate" smallint unsigned NULL;
   REPLICATE_NUM = ((1,1),(2,2),(3,3),(4,4))
   replicate =  models.PositiveSmallIntegerField(choices=REPLICATE_NUM,default=1) 
-
-  EXPERIMENT_TYPES = (
-      ('INPUT_RXLCh','INPUT_RXLCh'),
-      ('ChIP-seq', 'ChIP-seq'),
-      ('Sheared', 'Sheared'),
-      ('RNA-seq', 'RNA-seq'),
-      ('Methyl-seq', 'Methyl-seq'),
-      ('DIP-seq', 'DIP-seq'),
-    ) 
-  experiment_type = models.CharField(max_length=50, choices=EXPERIMENT_TYPES,
-                                     default='RNA-seq')
-  
+  experiment_type = models.ForeignKey(ExperimentType)
+  library_type = models.ForeignKey(LibraryType, null=True)
   creation_date = models.DateField(blank=True, null=True)
   made_for = models.CharField(max_length=50, blank=True, 
       verbose_name='ChIP/DNA/RNA Made By')
@@ -151,12 +156,13 @@ class Library(models.Model):
       ('Done', 'Completed'),
     )
   stopping_point = models.CharField(max_length=25, choices=PROTOCOL_END_POINTS, default='Done')
-  amplified_from_sample = models.ForeignKey('self', blank=True, null=True)  
+  amplified_from_sample = models.ForeignKey('self', blank=True, null=True, related_name='amplified_into_sample')  
   
   undiluted_concentration = models.DecimalField("Concentration", 
-      max_digits=5, decimal_places=2, default=0, blank=True, null=True,
-      help_text="Undiluted concentration (ng/ul)")
-  successful_pM = models.DecimalField(max_digits=5, decimal_places=2, blank=True, null=True)
+      max_digits=5, decimal_places=2, blank=True, null=True,
+      help_text=u"Undiluted concentration (ng/\u00b5l)") 
+      # note \u00b5 is the micro symbol in unicode
+  successful_pM = models.DecimalField(max_digits=9, decimal_places=1, blank=True, null=True)
   ten_nM_dilution = models.BooleanField()
   avg_lib_size = models.IntegerField(default=225, blank=True, null=True)
   notes = models.TextField(blank=True)
@@ -166,7 +172,8 @@ class Library(models.Model):
   
   class Meta:
     verbose_name_plural = "libraries"
-    ordering = ["-creation_date"] #["-library_id"]
+    #ordering = ["-creation_date"] 
+    ordering = ["-library_id"]
   
   def antibody_name(self):
     str ='<a target=_self href="/admin/samples/antibody/'+self.antibody.id.__str__()+'/" title="'+self.antibody.__str__()+'">'+self.antibody.nickname+'</a>' 
@@ -183,6 +190,15 @@ class Library(models.Model):
     for t in affs:
         ar.append(t.__unicode__())
     return '%s' % (", ".join(ar))
+    
+  def is_archived(self):
+    """
+    returns True if archived else False
+    """
+    if self.longtermstorage_set.count() > 0:
+        return True
+    else:
+        return False
 
   def libtags(self):
     affs = self.tags.all().order_by('tag_name')
@@ -229,3 +245,12 @@ class Library(models.Model):
     return tstr
   aligned_reads.allow_tags = True
 
+  def public(self):
+    SITE_ROOT = '/'
+    summary_url = self.get_absolute_url()
+    return '<a href="%s">S</a>' % (summary_url,)
+  public.allow_tags = True
+
+  @models.permalink
+  def get_absolute_url(self):
+    return ('htsworkflow.frontend.samples.views.library_to_flowcells', [str(self.library_id)])