This includes the version number, run date, bustard executable parameters, and
phasing estimates.
"""
+from copy import copy
from datetime import date
from glob import glob
import logging
import os
-import time
import re
+import sys
+import time
from htsworkflow.pipelines.runfolder import \
ElementTree, \
# make epydoc happy
__docformat__ = "restructuredtext en"
+LANE_LIST = range(1,9)
+
class Phasing(object):
PHASING = 'Phasing'
PREPHASING = 'Prephasing'
def get_elements(self):
root = ElementTree.Element(Phasing.PHASING, {'lane': str(self.lane)})
+ root.tail = os.linesep
phasing = ElementTree.SubElement(root, Phasing.PHASING)
phasing.text = str(self.phasing)
+ phasing.tail = os.linesep
prephasing = ElementTree.SubElement(root, Phasing.PREPHASING)
prephasing.text = str(self.prephasing)
+ prephasing.tail = os.linesep
return root
def set_elements(self, tree):
elif element.tag == Phasing.PREPHASING:
self.prephasing = float(element.text)
+class CrosstalkMatrix(object):
+ CROSSTALK = "MatrixElements"
+ BASE = 'Base'
+ ELEMENT = 'Element'
+
+ def __init__(self, fromfile=None, xml=None):
+ self.base = {}
+
+ if fromfile is not None:
+ self._initialize_from_file(fromfile)
+ elif xml is not None:
+ self.set_elements(xml)
+
+ def _initialize_from_file(self, pathname):
+ data = open(pathname).readlines()
+ auto_header = '# Auto-generated frequency response matrix'
+ if data[0].strip() != auto_header or len(data) != 9:
+ raise RuntimeError("matrix file %s is unusual" % (pathname,))
+ # skip over lines 1,2,3,4 which contain the 4 bases
+ self.base['A'] = [ float(v) for v in data[5].split() ]
+ self.base['C'] = [ float(v) for v in data[6].split() ]
+ self.base['G'] = [ float(v) for v in data[7].split() ]
+ self.base['T'] = [ float(v) for v in data[8].split() ]
+
+ def get_elements(self):
+ root = ElementTree.Element(CrosstalkMatrix.CROSSTALK)
+ root.tail = os.linesep
+ base_order = ['A','C','G','T']
+ for b in base_order:
+ base_element = ElementTree.SubElement(root, CrosstalkMatrix.BASE)
+ base_element.text = b
+ base_element.tail = os.linesep
+ for b in base_order:
+ for value in self.base[b]:
+ crosstalk_value = ElementTree.SubElement(root, CrosstalkMatrix.ELEMENT)
+ crosstalk_value.text = unicode(value)
+ crosstalk_value.tail = os.linesep
+
+ return root
+
+ def set_elements(self, tree):
+ if tree.tag != CrosstalkMatrix.CROSSTALK:
+ raise ValueError('Invalid run-xml exptected '+CrosstalkMatrix.CROSSTALK)
+ base_order = []
+ current_base = None
+ current_index = 0
+ for element in tree.getchildren():
+ # read in the order of the bases
+ if element.tag == 'Base':
+ base_order.append(element.text)
+ elif element.tag == 'Element':
+ # we're done reading bases, now its just the 4x4 matrix
+ # written out as a list of elements
+ # if this is the first element, make a copy of the list
+ # to play with and initialize an empty list for the current base
+ if current_base is None:
+ current_base = copy(base_order)
+ self.base[current_base[0]] = []
+ # we found (probably) 4 bases go to the next base
+ if current_index == len(base_order):
+ current_base.pop(0)
+ current_index = 0
+ self.base[current_base[0]] = []
+ value = float(element.text)
+ self.base[current_base[0]].append(value)
+
+ current_index += 1
+ else:
+ raise RuntimeError("Unrecognized tag in run xml: %s" %(element.tag,))
+
+def crosstalk_matrix_from_bustard_config(bustard_path, bustard_config_tree):
+ """
+ Analyze the bustard config file and try to find the crosstalk matrix.
+ """
+ bustard_run = bustard_config_tree[0]
+ if bustard_run.tag != 'Run':
+ raise RuntimeError('Expected Run tag, got %s' % (bustard_run.tag,))
+
+ call_parameters = bustard_run.find('BaseCallParameters')
+ if call_parameters is None:
+ raise RuntimeError('Missing BaseCallParameters section')
+
+ matrix = call_parameters.find('Matrix')
+ if matrix is None:
+ raise RuntimeError('Expected to find Matrix in Bustard BaseCallParameters')
+
+ matrix_auto_flag = int(matrix.find('AutoFlag').text)
+ matrix_auto_lane = int(matrix.find('AutoLane').text)
+
+ if matrix_auto_flag:
+ # we estimated the matrix from something in this run.
+ # though we don't really care which lane it was
+ matrix_path = os.path.join(bustard_path, 'Matrix', 's_02_matrix.txt')
+ matrix = CrosstalkMatrix(matrix_path)
+ else:
+ # the matrix was provided
+ matrix_elements = call_parameters.find('MatrixElements')
+ if matrix_elements is None:
+ raise RuntimeError('Expected to find MatrixElements in Bustard BaseCallParameters')
+ matrix = CrosstalkMatrix(xml=matrix_elements)
+
+ print "matrix:", matrix
+ return matrix
+
class Bustard(object):
- XML_VERSION = 1
+ XML_VERSION = 2
# Xml Tags
BUSTARD = 'Bustard'
DATE = 'run_time'
USER = 'user'
PARAMETERS = 'Parameters'
+ BUSTARD_CONFIG = 'BaseCallAnalysis'
def __init__(self, xml=None):
self.version = None
self.date = date.today()
self.user = None
self.phasing = {}
+ self.crosstalk = {}
self.pathname = None
+ self.bustard_config = None
if xml is not None:
self.set_elements(xml)
time = property(_get_time, doc='return run time as seconds since epoch')
def dump(self):
- print "Bustard version:", self.version
- print "Run date", self.date
- print "user:", self.user
- for lane, tree in self.phasing.items():
- print lane
- print tree
+ #print ElementTree.tostring(self.get_elements())
+ ElementTree.dump(self.get_elements())
def get_elements(self):
root = ElementTree.Element('Bustard',
user = ElementTree.SubElement(root, Bustard.USER)
user.text = self.user
params = ElementTree.SubElement(root, Bustard.PARAMETERS)
- for p in self.phasing.values():
- params.append(p.get_elements())
+
+ for lane in LANE_LIST:
+ params.append(self.phasing[lane].get_elements())
+ #params.append(self.crosstalk[lane].get_elements())
+
+ if self.bustard_config is not None:
+ root.append(self.bustard_config)
return root
def set_elements(self, tree):
for param in element:
p = Phasing(xml=param)
self.phasing[p.lane] = p
+ elif element.tag == Bustard.BUSTARD_CONFIG:
+ self.bustard_config = element
else:
raise ValueError("Unrecognized tag: %s" % (element.tag,))
-
-
def bustard(pathname):
"""
Construct a Bustard object by analyzing an Illumina Bustard directory.
Fully initialized Bustard object.
"""
b = Bustard()
+ pathname = os.path.abspath(pathname)
path, name = os.path.split(pathname)
groups = name.split("_")
version = re.search(VERSION_RE, groups[0])
b.date = date(*t[0:3])
b.user = groups[2]
b.pathname = pathname
+ bustard_config_filename = os.path.join(pathname, 'config.xml')
+ print bustard_config_filename
paramfiles = glob(os.path.join(pathname, "params?.xml"))
for paramfile in paramfiles:
phasing = Phasing(paramfile)
assert (phasing.lane >= 1 and phasing.lane <= 8)
b.phasing[phasing.lane] = phasing
+ # I only found these in Bustard1.9.5/1.9.6 directories
+ if b.version in ('1.9.5', '1.9.6'):
+ # at least for our runfolders for 1.9.5 and 1.9.6 matrix[1-8].txt are always the same
+ crosstalk_file = os.path.join(pathname, "matrix1.txt")
+ b.crosstalk = CrosstalkMatrix(crosstalk_file)
+ # for version 1.3.2 of the pipeline the bustard version number went down
+ # to match the rest of the pipeline. However there's now a nifty
+ # new (useful) bustard config file.
+ elif os.path.exists(bustard_config_filename):
+ bustard_config_root = ElementTree.parse(bustard_config_filename)
+ b.bustard_config = bustard_config_root.getroot()
+ b.crosstalk = crosstalk_matrix_from_bustard_config(b.pathname, b.bustard_config)
+
return b
def fromxml(tree):
b = Bustard()
b.set_elements(tree)
return b
+
+def make_cmdline_parser():
+ from optparse import OptionParser
+ parser = OptionParser('%prog: bustard_directory')
+ return parser
+
+def main(cmdline):
+ parser = make_cmdline_parser()
+ opts, args = parser.parse_args(cmdline)
+
+ for bustard_dir in args:
+ print u'analyzing bustard directory: ' + unicode(bustard_dir)
+ bustard_object = bustard(bustard_dir)
+ bustard_object.dump()
+
+ bustard_object2 = Bustard(xml=bustard_object.get_elements())
+ print ('-------------------------------------')
+ bustard_object2.dump()
+ print ('=====================================')
+ b1_tree = bustard_object.get_elements()
+ b1 = ElementTree.tostring(b1_tree).split(os.linesep)
+ b2_tree = bustard_object2.get_elements()
+ b2 = ElementTree.tostring(b2_tree).split(os.linesep)
+ for line1, line2 in zip(b1, b2):
+ if b1 != b2:
+ print "b1: ", b1
+ print "b2: ", b2
+
+if __name__ == "__main__":
+ main(sys.argv[1:])
projects / htsworkflow.git / blobdiff