2 Extract configuration from Illumina Bustard Directory.
4 This includes the version number, run date, bustard executable parameters, and
8 from datetime import date
16 from htsworkflow.pipelines.runfolder import \
21 LOGGER = logging.getLogger(__name__)
24 __docformat__ = "restructuredtext en"
26 LANE_LIST = range(1,9)
28 class Phasing(object):
30 PREPHASING = 'Prephasing'
32 def __init__(self, fromfile=None, xml=None):
35 self.prephasing = None
37 if fromfile is not None:
38 self._initialize_from_file(fromfile)
40 self.set_elements(xml)
42 def _initialize_from_file(self, pathname):
43 path, name = os.path.split(pathname)
44 basename, ext = os.path.splitext(name)
45 # the last character of the param base filename should be the
47 tree = ElementTree.parse(pathname).getroot()
48 self.set_elements(tree)
49 self.lane = int(basename[-1])
51 def get_elements(self):
52 root = ElementTree.Element(Phasing.PHASING, {'lane': str(self.lane)})
53 root.tail = os.linesep
54 phasing = ElementTree.SubElement(root, Phasing.PHASING)
55 phasing.text = str(self.phasing)
56 phasing.tail = os.linesep
57 prephasing = ElementTree.SubElement(root, Phasing.PREPHASING)
58 prephasing.text = str(self.prephasing)
59 prephasing.tail = os.linesep
62 def set_elements(self, tree):
63 if tree.tag not in ('Phasing', 'Parameters'):
64 raise ValueError('exptected Phasing or Parameters')
65 lane = tree.attrib.get('lane', None)
68 for element in list(tree):
69 if element.tag == Phasing.PHASING:
70 self.phasing = float(element.text)
71 elif element.tag == Phasing.PREPHASING:
72 self.prephasing = float(element.text)
74 class CrosstalkMatrix(object):
75 CROSSTALK = "MatrixElements"
79 def __init__(self, fromfile=None, xml=None):
82 if fromfile is not None:
83 self._initialize_from_file(fromfile)
85 self.set_elements(xml)
87 def _initialize_from_file(self, pathname):
88 data = open(pathname).readlines()
89 auto_header = '# Auto-generated frequency response matrix'
90 if data[0].strip() == auto_header and len(data) == 9:
91 # skip over lines 1,2,3,4 which contain the 4 bases
92 self.base['A'] = [ float(v) for v in data[5].split() ]
93 self.base['C'] = [ float(v) for v in data[6].split() ]
94 self.base['G'] = [ float(v) for v in data[7].split() ]
95 self.base['T'] = [ float(v) for v in data[8].split() ]
97 self.base['A'] = [ float(v) for v in data[:4] ]
98 self.base['C'] = [ float(v) for v in data[4:8] ]
99 self.base['G'] = [ float(v) for v in data[8:12] ]
100 self.base['T'] = [ float(v) for v in data[12:16] ]
102 raise RuntimeError("matrix file %s is unusual" % (pathname,))
103 def get_elements(self):
104 root = ElementTree.Element(CrosstalkMatrix.CROSSTALK)
105 root.tail = os.linesep
106 base_order = ['A','C','G','T']
108 base_element = ElementTree.SubElement(root, CrosstalkMatrix.BASE)
109 base_element.text = b
110 base_element.tail = os.linesep
112 for value in self.base[b]:
113 crosstalk_value = ElementTree.SubElement(root, CrosstalkMatrix.ELEMENT)
114 crosstalk_value.text = unicode(value)
115 crosstalk_value.tail = os.linesep
119 def set_elements(self, tree):
120 if tree.tag != CrosstalkMatrix.CROSSTALK:
121 raise ValueError('Invalid run-xml exptected '+CrosstalkMatrix.CROSSTALK)
125 for element in tree.getchildren():
126 # read in the order of the bases
127 if element.tag == 'Base':
128 base_order.append(element.text)
129 elif element.tag == 'Element':
130 # we're done reading bases, now its just the 4x4 matrix
131 # written out as a list of elements
132 # if this is the first element, make a copy of the list
133 # to play with and initialize an empty list for the current base
134 if current_base is None:
135 current_base = copy(base_order)
136 self.base[current_base[0]] = []
137 # we found (probably) 4 bases go to the next base
138 if current_index == len(base_order):
141 self.base[current_base[0]] = []
142 value = float(element.text)
143 self.base[current_base[0]].append(value)
147 raise RuntimeError("Unrecognized tag in run xml: %s" %(element.tag,))
149 def crosstalk_matrix_from_bustard_config(bustard_path, bustard_config_tree):
151 Analyze the bustard config file and try to find the crosstalk matrix.
153 bustard_run = bustard_config_tree[0]
154 if bustard_run.tag != 'Run':
155 raise RuntimeError('Expected Run tag, got %s' % (bustard_run.tag,))
157 call_parameters = bustard_run.find('BaseCallParameters')
158 if call_parameters is None:
159 raise RuntimeError('Missing BaseCallParameters section')
161 matrix = call_parameters.find('Matrix')
163 raise RuntimeError('Expected to find Matrix in Bustard BaseCallParameters')
165 matrix_auto_flag = int(matrix.find('AutoFlag').text)
166 matrix_auto_lane = int(matrix.find('AutoLane').text)
170 # we estimated the matrix from something in this run.
171 # though we don't really care which lane it was
172 if matrix_auto_lane == 0:
173 auto_lane_fragment = ""
175 auto_lane_fragment = "_%d" % ( matrix_auto_lane,)
177 for matrix_name in ['s%s_02_matrix.txt' % (auto_lane_fragment,),
178 's%s_1_matrix.txt' % (auto_lane_fragment,),
180 matrix_path = os.path.join(bustard_path, 'Matrix', matrix_name)
181 if os.path.exists(matrix_path):
184 raise RuntimeError("Couldn't find matrix for lane %d" % \
187 crosstalk = CrosstalkMatrix(matrix_path)
189 matrix_elements = call_parameters.find('MatrixElements')
190 # the matrix was provided
191 if matrix_elements is not None:
192 crosstalk = CrosstalkMatrix(xml=matrix_elements)
194 # we have no crosstalk matrix?
199 class Bustard(object):
204 SOFTWARE_VERSION = 'version'
207 PARAMETERS = 'Parameters'
208 BUSTARD_CONFIG = 'BaseCallAnalysis'
210 def __init__(self, xml=None):
211 self._path_version = None # version number from directory name
215 self.crosstalk = None
217 self.bustard_config = None
220 self.set_elements(xml)
222 def update_attributes_from_pathname(self):
223 """Update version, date, user from bustard directory names
224 Obviously this wont work for BaseCalls or later runfolders
226 if self.pathname is None:
228 "Set pathname before calling update_attributes_from_pathname")
229 path, name = os.path.split(self.pathname)
231 if not re.match('bustard', name, re.IGNORECASE):
234 groups = name.split("_")
235 version = re.search(VERSION_RE, groups[0])
236 self._path_version = version.group(1)
237 t = time.strptime(groups[1], EUROPEAN_STRPTIME)
238 self.date = date(*t[0:3])
239 self.user = groups[2]
241 def _get_software_version(self):
242 """return software name, version tuple"""
243 if self.bustard_config is None:
244 if self._path_version is not None:
245 return 'Bustard', self._path_version
248 software_nodes = self.bustard_config.xpath('Run/Software')
249 if len(software_nodes) == 0:
251 elif len(software_nodes) > 1:
252 raise RuntimeError("Too many software XML elements for bustard.py")
254 return (software_nodes[0].attrib['Name'],
255 software_nodes[0].attrib['Version'])
257 def _get_software(self):
258 """Return software name"""
259 software_version = self._get_software_version()
260 return software_version[0] if software_version is not None else None
261 software = property(_get_software)
263 def _get_version(self):
264 """Return software name"""
265 software_version = self._get_software_version()
266 return software_version[1] if software_version is not None else None
267 version = property(_get_version)
271 if self.date is None:
273 return time.mktime(self.date.timetuple())
274 time = property(_get_time, doc='return run time as seconds since epoch')
277 #print ElementTree.tostring(self.get_elements())
278 ElementTree.dump(self.get_elements())
280 def get_elements(self):
281 root = ElementTree.Element('Bustard',
282 {'version': str(Bustard.XML_VERSION)})
283 version = ElementTree.SubElement(root, Bustard.SOFTWARE_VERSION)
284 version.text = self.version
285 if self.time is not None:
286 run_date = ElementTree.SubElement(root, Bustard.DATE)
287 run_date.text = str(self.time)
288 if self.user is not None:
289 user = ElementTree.SubElement(root, Bustard.USER)
290 user.text = self.user
291 params = ElementTree.SubElement(root, Bustard.PARAMETERS)
293 # add phasing parameters
294 for lane in LANE_LIST:
295 if self.phasing.has_key(lane):
296 params.append(self.phasing[lane].get_elements())
298 # add crosstalk matrix if it exists
299 if self.crosstalk is not None:
300 root.append(self.crosstalk.get_elements())
302 # add bustard config if it exists
303 if self.bustard_config is not None:
304 root.append(self.bustard_config)
307 def set_elements(self, tree):
308 if tree.tag != Bustard.BUSTARD:
309 raise ValueError('Expected "Bustard" SubElements')
310 xml_version = int(tree.attrib.get('version', 0))
311 if xml_version > Bustard.XML_VERSION:
312 LOGGER.warn('Bustard XML tree is a higher version than this class')
313 for element in list(tree):
314 if element.tag == Bustard.SOFTWARE_VERSION:
315 self._path_version = element.text
316 elif element.tag == Bustard.DATE:
317 self.date = date.fromtimestamp(float(element.text))
318 elif element.tag == Bustard.USER:
319 self.user = element.text
320 elif element.tag == Bustard.PARAMETERS:
321 for param in element:
322 p = Phasing(xml=param)
323 self.phasing[p.lane] = p
324 elif element.tag == CrosstalkMatrix.CROSSTALK:
325 self.crosstalk = CrosstalkMatrix(xml=element)
326 elif element.tag == Bustard.BUSTARD_CONFIG:
327 self.bustard_config = element
329 raise ValueError("Unrecognized tag: %s" % (element.tag,))
331 def bustard(pathname):
333 Construct a Bustard object by analyzing an Illumina Bustard directory.
336 - `pathname`: A bustard directory
339 Fully initialized Bustard object.
341 pathname = os.path.abspath(pathname)
342 bustard_filename = os.path.join(pathname, 'config.xml')
343 demultiplexed_filename = os.path.join(pathname,
344 'DemultiplexedBustardConfig.xml')
346 if os.path.exists(demultiplexed_filename):
347 b = bustard_from_hiseq(pathname, demultiplexed_filename)
348 elif os.path.exists(bustard_filename):
349 b = bustard_from_ga2(pathname, bustard_filename)
351 b = bustard_from_ga1(pathname)
355 def bustard_from_ga1(pathname):
356 """Initialize bustard class from ga1 era runfolders.
358 path, name = os.path.split(pathname)
360 groups = name.split("_")
362 msg = "Not enough information to create attributes"\
363 " from directory name: %s"
364 LOGGER.error(msg % (self.pathname,))
368 b.pathname = pathname
369 b.update_attributes_from_pathname()
370 version = re.search(VERSION_RE, groups[0])
371 b._path_version = version.group(1)
372 t = time.strptime(groups[1], EUROPEAN_STRPTIME)
373 b.date = date(*t[0:3])
376 # I only found these in Bustard1.9.5/1.9.6 directories
377 if b.version in ('1.9.5', '1.9.6'):
378 # at least for our runfolders for 1.9.5 and 1.9.6 matrix[1-8].txt are always the same
379 crosstalk_file = os.path.join(pathname, "matrix1.txt")
380 b.crosstalk = CrosstalkMatrix(crosstalk_file)
386 def bustard_from_ga2(pathname, config_filename):
387 """Initialize bustard class from ga2-era runfolder
388 Actually I don't quite remember if it is exactly the GA2s, but
389 its after the original runfolder style and before the HiSeq.
391 # for version 1.3.2 of the pipeline the bustard version number went down
392 # to match the rest of the pipeline. However there's now a nifty
393 # new (useful) bustard config file.
397 b.pathname = pathname
398 b.update_attributes_from_pathname()
399 bustard_config_root = ElementTree.parse(config_filename)
400 b.bustard_config = bustard_config_root.getroot()
401 b.crosstalk = crosstalk_matrix_from_bustard_config(b.pathname,
407 def bustard_from_hiseq(pathname, config_filename):
409 b.pathname = pathname
410 bustard_config_root = ElementTree.parse(config_filename)
411 b.bustard_config = bustard_config_root.getroot()
415 def add_phasing(bustard_obj):
416 paramfiles = glob(os.path.join(bustard_obj.pathname,
418 for paramfile in paramfiles:
419 phasing = Phasing(paramfile)
420 assert (phasing.lane >= 1 and phasing.lane <= 8)
421 bustard_obj.phasing[phasing.lane] = phasing
425 Reconstruct a htsworkflow.pipelines.Bustard object from an xml block
431 def make_cmdline_parser():
432 from optparse import OptionParser
433 parser = OptionParser('%prog: bustard_directory')
437 parser = make_cmdline_parser()
438 opts, args = parser.parse_args(cmdline)
440 for bustard_dir in args:
441 print u'analyzing bustard directory: ' + unicode(bustard_dir)
442 bustard_object = bustard(bustard_dir)
443 bustard_object.dump()
445 bustard_object2 = Bustard(xml=bustard_object.get_elements())
446 print ('-------------------------------------')
447 bustard_object2.dump()
448 print ('=====================================')
449 b1_tree = bustard_object.get_elements()
450 b1 = ElementTree.tostring(b1_tree).split(os.linesep)
451 b2_tree = bustard_object2.get_elements()
452 b2 = ElementTree.tostring(b2_tree).split(os.linesep)
453 for line1, line2 in zip(b1, b2):
458 if __name__ == "__main__":