annotate homer.py @ 54:675d25a0b9d4

Uploaded
author bgruening
date Mon, 12 Aug 2013 08:16:21 -0400
parents
children e9cd105a8856
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
1 """
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
2 HOMER special datatypes
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
3 """
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
4
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
5 from galaxy.datatypes.data import get_file_peek
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
6 from galaxy.datatypes.data import Text, Data
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
7 from galaxy.datatypes.metadata import MetadataElement
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
8 from galaxy.datatypes.images import Html
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
9
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
10
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
11 class TagDirectory(object):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
12 """Base class for HOMER's Tag Directory datatype."""
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
13
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
14 file_ext = 'homer_tagdir'
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
15 composite_type = 'auto_primary_file'
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
16 allow_datatype_change = False
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
17
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
18 def __init__(self, **kwd):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
19 Text.__init__( self, **kwd )
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
20 #self.add_composite_file('tagInfo.txt', description = 'basic configuration information', mimetype = 'text/html') # Contains basic configuration information
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
21 self.add_composite_file('tagLengthDistribution.txt', description = 'histogram of read lengths used for alignment', mimetype = 'text/html') # File contains a histogram of read lengths used for alignment.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
22 self.add_composite_file('tagCountDistribution.txt', description = 'histogram of clonal read depth, showing the number of reads per unique position', mimetype = 'text/html') # File contains a histogram of clonal read depth, showing the number of reads per unique position.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
23 self.add_composite_file('tagAutocorrelation.txt', description = 'distribution of distances between adjacent reads in the genome', mimetype = 'text/html') # The autocorrelation routine creates a distribution of distances between adjacent reads in the genome.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
24 self.add_composite_file('tagFreq.txt', description = "nucleotide and dinucleotide frequencies as a function of distance from the 5' end of all reads", mimetype = 'text/html', optional=True) # Calculates the nucleotide and dinucleotide frequencies as a function of distance from the 5' end of all reads.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
25 self.add_composite_file('tagFreqUniq.txt', description = "nucleotide and dinucleotide frequencies as a function of distance from the 5' end of all reads (counted only once)", mimetype = 'text/html', optional=True) # Same as tagFreq.txt, however individual genomic positions are only counted once.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
26 self.add_composite_file('tagGCcontent.txt', description = 'Distribution of fragment GC%-content', mimetype = 'text/html', optional=True) # Distribution of fragment GC%-content.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
27 self.add_composite_file('genomeGCcontent.txt', description = 'Distribution of fragment GC%-content at each location in the genome', mimetype = 'text/html', optional=True) # Distribution of fragment GC%-content at each location in the genome.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
28
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
29 def generate_primary_file( self, dataset = None ):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
30 rval = ['<html><head><title>HOMER database files</title></head><ul>']
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
31 for composite_name, composite_file in self.get_composite_files( dataset = dataset ).iteritems():
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
32 opt_text = ''
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
33 if composite_file.optional:
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
34 opt_text = ' (optional)'
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
35 rval.append( '<li><a href="%s">%s</a>%s' % ( composite_name, composite_name, opt_text ) )
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
36 rval.append( '</ul></html>' )
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
37 return "\n".join( rval )
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
38
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
39 def display_data(self, trans, data, preview=False, filename=None,
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
40 to_ext=None, size=None, offset=None, **kwd):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
41 """Apparently an old display method, but still gets called.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
42
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
43 This allows us to format the data shown in the central pane via the "eye" icon.
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
44 """
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
45 return "This is a HOMER database."
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
46
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
47 def set_peek( self, dataset, is_multi_byte=False ):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
48 """Set the peek and blurb text."""
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
49 if not dataset.dataset.purged:
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
50 dataset.peek = "HOMER database (multiple files)"
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
51 dataset.blurb = "HOMER database (multiple files)"
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
52 else:
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
53 dataset.peek = 'file does not exist'
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
54 dataset.blurb = 'file purged from disk'
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
55
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
56 def display_peek( self, dataset ):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
57 """Create HTML content, used for displaying peek."""
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
58 try:
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
59 return dataset.peek
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
60 except:
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
61 return "HOMER database (multiple files)"
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
62
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
63 def get_mime(self):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
64 """Returns the mime type of the datatype (pretend it is text for peek)"""
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
65 return 'text/plain'
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
66
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
67 def merge(split_files, output_file):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
68 """Merge HOMER databases (not implemented)."""
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
69 raise NotImplementedError("Merging HOMER databases is not supported")
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
70
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
71 def split( cls, input_datasets, subdir_generator_function, split_params):
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
72 """Split a HOMER database (not implemented)."""
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
73 if split_params is None:
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
74 return None
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
75 raise NotImplementedError("Can't split HOMER databases")
675d25a0b9d4 Uploaded
bgruening
parents:
diff changeset
76