htsworkflow/pipelines/bustard.py

   1 """
   2 Extract configuration from Illumina Bustard Directory.
   3
   4 This includes the version number, run date, bustard executable parameters, and
   5 phasing estimates.
   6 """
   7 from copy import copy
   8 from datetime import date
   9 from glob import glob
  10 import logging
  11 import os
  12 import re
  13 import sys
  14 import time
  15
  16 from htsworkflow.pipelines.runfolder import \
  17    ElementTree, \
  18    VERSION_RE, \
  19    EUROPEAN_STRPTIME
  20
  21 LOGGER = logging.getLogger(__name__)
  22
  23 # make epydoc happy
  24 __docformat__ = "restructuredtext en"
  25
  26 LANE_LIST = range(1,9)
  27
  28 class Phasing(object):
  29     PHASING = 'Phasing'
  30     PREPHASING = 'Prephasing'
  31
  32     def __init__(self, fromfile=None, xml=None):
  33         self.lane = None
  34         self.phasing = None
  35         self.prephasing = None
  36
  37         if fromfile is not None:
  38             self._initialize_from_file(fromfile)
  39         elif xml is not None:
  40             self.set_elements(xml)
  41
  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
  46         # lane number
  47         tree = ElementTree.parse(pathname).getroot()
  48         self.set_elements(tree)
  49         self.lane = int(basename[-1])
  50
  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
  60         return root
  61
  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)
  66         if lane is not None:
  67             self.lane = int(lane)
  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)
  73
  74 class CrosstalkMatrix(object):
  75     CROSSTALK = "MatrixElements"
  76     BASE = 'Base'
  77     ELEMENT = 'Element'
  78
  79     def __init__(self, fromfile=None, xml=None):
  80         self.base = {}
  81
  82         if fromfile is not None:
  83             self._initialize_from_file(fromfile)
  84         elif xml is not None:
  85             self.set_elements(xml)
  86
  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() ]
  96         elif len(data) == 16:
  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] ]
 101         else:
 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']
 107         for b in base_order:
 108             base_element = ElementTree.SubElement(root, CrosstalkMatrix.BASE)
 109             base_element.text = b
 110             base_element.tail = os.linesep
 111         for b in base_order:
 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
 116
 117         return root
 118
 119     def set_elements(self, tree):
 120         if tree.tag != CrosstalkMatrix.CROSSTALK:
 121             raise ValueError('Invalid run-xml exptected '+CrosstalkMatrix.CROSSTALK)
 122         base_order = []
 123         current_base = None
 124         current_index = 0
 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):
 139                     current_base.pop(0)
 140                     current_index = 0
 141                     self.base[current_base[0]] = []
 142                 value = float(element.text)
 143                 self.base[current_base[0]].append(value)
 144
 145                 current_index += 1
 146             else:
 147                 raise RuntimeError("Unrecognized tag in run xml: %s" %(element.tag,))
 148
 149 def crosstalk_matrix_from_bustard_config(bustard_path, bustard_config_tree):
 150     """
 151     Analyze the bustard config file and try to find the crosstalk matrix.
 152     """
 153     bustard_run = bustard_config_tree[0]
 154     if bustard_run.tag != 'Run':
 155         raise RuntimeError('Expected Run tag, got %s' % (bustard_run.tag,))
 156
 157     call_parameters = bustard_run.find('BaseCallParameters')
 158     if call_parameters is None:
 159         raise RuntimeError('Missing BaseCallParameters section')
 160
 161     matrix = call_parameters.find('Matrix')
 162     if matrix is None:
 163         raise RuntimeError('Expected to find Matrix in Bustard BaseCallParameters')
 164
 165     matrix_auto_flag = int(matrix.find('AutoFlag').text)
 166     matrix_auto_lane = int(matrix.find('AutoLane').text)
 167
 168     crosstalk = None
 169     if matrix_auto_flag:
 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 = ""
 174         else:
 175             auto_lane_fragment = "_%d" % ( matrix_auto_lane,)
 176
 177         for matrix_name in ['s%s_02_matrix.txt' % (auto_lane_fragment,),
 178                             's%s_1_matrix.txt' % (auto_lane_fragment,),
 179                             ]:
 180             matrix_path = os.path.join(bustard_path, 'Matrix', matrix_name)
 181             if os.path.exists(matrix_path):
 182                 break
 183         else:
 184             raise RuntimeError("Couldn't find matrix for lane %d" % \
 185                                (matrix_auto_lane,))
 186
 187         crosstalk = CrosstalkMatrix(matrix_path)
 188     else:
 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)
 193         else:
 194             # we have no crosstalk matrix?
 195             pass
 196
 197     return crosstalk
 198
 199 class Bustard(object):
 200     XML_VERSION = 2
 201
 202     # Xml Tags
 203     BUSTARD = 'Bustard'
 204     SOFTWARE_VERSION = 'version'
 205     DATE = 'run_time'
 206     USER = 'user'
 207     PARAMETERS = 'Parameters'
 208     BUSTARD_CONFIG = 'BaseCallAnalysis'
 209
 210     def __init__(self, xml=None):
 211         self.version = None
 212         self.date = None
 213         self.user = None
 214         self.phasing = {}
 215         self.crosstalk = None
 216         self.pathname = None
 217         self.bustard_config = None
 218
 219         if xml is not None:
 220             self.set_elements(xml)
 221
 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
 225         """
 226         if self.pathname is None:
 227             raise ValueError(
 228                 "Set pathname before calling update_attributes_from_pathname")
 229         path, name = os.path.split(self.pathname)
 230
 231         if not re.match('bustard', name, re.IGNORECASE):
 232             return
 233
 234         groups = name.split("_")
 235         version = re.search(VERSION_RE, groups[0])
 236         self.version = version.group(1)
 237         t = time.strptime(groups[1], EUROPEAN_STRPTIME)
 238         self.date = date(*t[0:3])
 239         self.user = groups[2]
 240
 241     def _get_time(self):
 242         if self.date is None:
 243             return None
 244         return time.mktime(self.date.timetuple())
 245     time = property(_get_time, doc='return run time as seconds since epoch')
 246
 247     def dump(self):
 248         #print ElementTree.tostring(self.get_elements())
 249         ElementTree.dump(self.get_elements())
 250
 251     def get_elements(self):
 252         root = ElementTree.Element('Bustard',
 253                                    {'version': str(Bustard.XML_VERSION)})
 254         version = ElementTree.SubElement(root, Bustard.SOFTWARE_VERSION)
 255         version.text = self.version
 256         if self.time is not None:
 257             run_date = ElementTree.SubElement(root, Bustard.DATE)
 258             run_date.text = str(self.time)
 259         if self.user is not None:
 260             user = ElementTree.SubElement(root, Bustard.USER)
 261             user.text = self.user
 262         params = ElementTree.SubElement(root, Bustard.PARAMETERS)
 263
 264         # add phasing parameters
 265         for lane in LANE_LIST:
 266             if self.phasing.has_key(lane):
 267                 params.append(self.phasing[lane].get_elements())
 268
 269         # add crosstalk matrix if it exists
 270         if self.crosstalk is not None:
 271             root.append(self.crosstalk.get_elements())
 272
 273         # add bustard config if it exists
 274         if self.bustard_config is not None:
 275             root.append(self.bustard_config)
 276         return root
 277
 278     def set_elements(self, tree):
 279         if tree.tag != Bustard.BUSTARD:
 280             raise ValueError('Expected "Bustard" SubElements')
 281         xml_version = int(tree.attrib.get('version', 0))
 282         if xml_version > Bustard.XML_VERSION:
 283             LOGGER.warn('Bustard XML tree is a higher version than this class')
 284         for element in list(tree):
 285             if element.tag == Bustard.SOFTWARE_VERSION:
 286                 self.version = element.text
 287             elif element.tag == Bustard.DATE:
 288                 self.date = date.fromtimestamp(float(element.text))
 289             elif element.tag == Bustard.USER:
 290                 self.user = element.text
 291             elif element.tag == Bustard.PARAMETERS:
 292                 for param in element:
 293                     p = Phasing(xml=param)
 294                     self.phasing[p.lane] = p
 295             elif element.tag == CrosstalkMatrix.CROSSTALK:
 296                 self.crosstalk = CrosstalkMatrix(xml=element)
 297             elif element.tag == Bustard.BUSTARD_CONFIG:
 298                 self.bustard_config = element
 299             else:
 300                 raise ValueError("Unrecognized tag: %s" % (element.tag,))
 301
 302 def bustard(pathname):
 303     """
 304     Construct a Bustard object by analyzing an Illumina Bustard directory.
 305
 306     :Parameters:
 307       - `pathname`: A bustard directory
 308
 309     :Return:
 310       Fully initialized Bustard object.
 311     """
 312     pathname = os.path.abspath(pathname)
 313     bustard_filename = os.path.join(pathname, 'config.xml')
 314     demultiplexed_filename = os.path.join(pathname,
 315                                           'DemultiplexedBustardConfig.xml')
 316
 317     if os.path.exists(demultiplexed_filename):
 318         b = bustard_from_hiseq(pathname, demultiplexed_filename)
 319     elif os.path.exists(bustard_filename):
 320         b = bustard_from_ga2(pathname, bustard_filename)
 321     else:
 322         b = bustard_from_ga1(pathname)
 323
 324     return b
 325
 326 def bustard_from_ga1(pathname):
 327     """Initialize bustard class from ga1 era runfolders.
 328     """
 329     path, name = os.path.split(pathname)
 330
 331     groups = name.split("_")
 332     if len(groups) < 3:
 333         msg = "Not enough information to create attributes"\
 334               " from directory name: %s"
 335         LOGGER.error(msg % (self.pathname,))
 336         return None
 337
 338     b = Bustard()
 339     b.pathname = pathname
 340     b.update_attributes_from_pathname()
 341     version = re.search(VERSION_RE, groups[0])
 342     b.version = version.group(1)
 343     t = time.strptime(groups[1], EUROPEAN_STRPTIME)
 344     b.date = date(*t[0:3])
 345     b.user = groups[2]
 346
 347     # I only found these in Bustard1.9.5/1.9.6 directories
 348     if b.version in ('1.9.5', '1.9.6'):
 349         # at least for our runfolders for 1.9.5 and 1.9.6 matrix[1-8].txt are always the same
 350         crosstalk_file = os.path.join(pathname, "matrix1.txt")
 351         b.crosstalk = CrosstalkMatrix(crosstalk_file)
 352
 353     add_phasing(b)
 354     return b
 355
 356
 357 def bustard_from_ga2(pathname, config_filename):
 358     """Initialize bustard class from ga2-era runfolder
 359     Actually I don't quite remember if it is exactly the GA2s, but
 360     its after the original runfolder style and before the HiSeq.
 361     """
 362     # for version 1.3.2 of the pipeline the bustard version number went down
 363     # to match the rest of the pipeline. However there's now a nifty
 364     # new (useful) bustard config file.
 365
 366     # stub values
 367     b = Bustard()
 368     b.pathname = pathname
 369     b.update_attributes_from_pathname()
 370     bustard_config_root = ElementTree.parse(config_filename)
 371     b.bustard_config = bustard_config_root.getroot()
 372     b.crosstalk = crosstalk_matrix_from_bustard_config(b.pathname,
 373                                                        b.bustard_config)
 374     software = bustard_config_root.find('*/Software')
 375     b.version = software.attrib['Version']
 376     add_phasing(b)
 377
 378     return b
 379
 380 def bustard_from_hiseq(pathname, config_filename):
 381     b = Bustard()
 382     b.pathname = pathname
 383     bustard_config_root = ElementTree.parse(config_filename)
 384     b.bustard_config = bustard_config_root.getroot()
 385     software = bustard_config_root.find('*/Software')
 386     b.version = software.attrib['Version']
 387     add_phasing(b)
 388     return b
 389
 390 def add_phasing(bustard_obj):
 391     paramfiles = glob(os.path.join(bustard_obj.pathname,
 392                                    "params?.xml"))
 393     for paramfile in paramfiles:
 394         phasing = Phasing(paramfile)
 395         assert (phasing.lane >= 1 and phasing.lane <= 8)
 396         bustard_obj.phasing[phasing.lane] = phasing
 397
 398 def fromxml(tree):
 399     """
 400     Reconstruct a htsworkflow.pipelines.Bustard object from an xml block
 401     """
 402     b = Bustard()
 403     b.set_elements(tree)
 404     return b
 405
 406 def make_cmdline_parser():
 407     from optparse import OptionParser
 408     parser = OptionParser('%prog: bustard_directory')
 409     return parser
 410
 411 def main(cmdline):
 412     parser = make_cmdline_parser()
 413     opts, args = parser.parse_args(cmdline)
 414
 415     for bustard_dir in args:
 416         print u'analyzing bustard directory: ' + unicode(bustard_dir)
 417         bustard_object = bustard(bustard_dir)
 418         bustard_object.dump()
 419
 420         bustard_object2 = Bustard(xml=bustard_object.get_elements())
 421         print ('-------------------------------------')
 422         bustard_object2.dump()
 423         print ('=====================================')
 424         b1_tree = bustard_object.get_elements()
 425         b1 = ElementTree.tostring(b1_tree).split(os.linesep)
 426         b2_tree = bustard_object2.get_elements()
 427         b2 = ElementTree.tostring(b2_tree).split(os.linesep)
 428         for line1, line2 in zip(b1, b2):
 429             if b1 != b2:
 430                 print "b1: ", b1
 431                 print "b2: ", b2
 432
 433 if __name__ == "__main__":
 434     main(sys.argv[1:])