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             # its defaulting to all of the lanes, so just pick one
 174             auto_lane_fragment = "_1"
 175         else:
 176             auto_lane_fragment = "_%d" % ( matrix_auto_lane,)
 177
 178         for matrix_name in ['s%s_02_matrix.txt' % (auto_lane_fragment,),
 179                             's%s_1_matrix.txt' % (auto_lane_fragment,),
 180                             ]:
 181             matrix_path = os.path.join(bustard_path, 'Matrix', matrix_name)
 182             if os.path.exists(matrix_path):
 183                 break
 184         else:
 185             raise RuntimeError("Couldn't find matrix for lane %d" % \
 186                                (matrix_auto_lane,))
 187
 188         crosstalk = CrosstalkMatrix(matrix_path)
 189     else:
 190         matrix_elements = call_parameters.find('MatrixElements')
 191         # the matrix was provided
 192         if matrix_elements is not None:
 193             crosstalk = CrosstalkMatrix(xml=matrix_elements)
 194         else:
 195             # we have no crosstalk matrix?
 196             pass
 197
 198     return crosstalk
 199
 200 class Bustard(object):
 201     XML_VERSION = 2
 202
 203     # Xml Tags
 204     BUSTARD = 'Bustard'
 205     SOFTWARE_VERSION = 'version'
 206     DATE = 'run_time'
 207     USER = 'user'
 208     PARAMETERS = 'Parameters'
 209     BUSTARD_CONFIG = 'BaseCallAnalysis'
 210
 211     def __init__(self, xml=None):
 212         self._path_version = None # version number from directory name
 213         self.date = None
 214         self.user = None
 215         self.phasing = {}
 216         self.crosstalk = None
 217         self.pathname = None
 218         self.bustard_config = None
 219
 220         if xml is not None:
 221             self.set_elements(xml)
 222
 223     def update_attributes_from_pathname(self):
 224         """Update version, date, user from bustard directory names
 225         Obviously this wont work for BaseCalls or later runfolders
 226         """
 227         if self.pathname is None:
 228             raise ValueError(
 229                 "Set pathname before calling update_attributes_from_pathname")
 230         path, name = os.path.split(self.pathname)
 231
 232         if not re.match('bustard', name, re.IGNORECASE):
 233             return
 234
 235         groups = name.split("_")
 236         version = re.search(VERSION_RE, groups[0])
 237         self._path_version = version.group(1)
 238         t = time.strptime(groups[1], EUROPEAN_STRPTIME)
 239         self.date = date(*t[0:3])
 240         self.user = groups[2]
 241
 242     def _get_software_version(self):
 243         """return software name, version tuple"""
 244         if self.bustard_config is None:
 245             if self._path_version is not None:
 246                 return 'Bustard', self._path_version
 247             else:
 248                 return None
 249         software_nodes = self.bustard_config.xpath('Run/Software')
 250         if len(software_nodes) == 0:
 251             return None
 252         elif len(software_nodes) > 1:
 253             raise RuntimeError("Too many software XML elements for bustard.py")
 254         else:
 255             return (software_nodes[0].attrib['Name'],
 256                     software_nodes[0].attrib['Version'])
 257
 258     def _get_software(self):
 259         """Return software name"""
 260         software_version = self._get_software_version()
 261         return software_version[0] if software_version is not None else None
 262     software = property(_get_software)
 263
 264     def _get_version(self):
 265         """Return software name"""
 266         software_version = self._get_software_version()
 267         return software_version[1] if software_version is not None else None
 268     version = property(_get_version)
 269
 270
 271     def _get_time(self):
 272         if self.date is None:
 273             return None
 274         return time.mktime(self.date.timetuple())
 275     time = property(_get_time, doc='return run time as seconds since epoch')
 276
 277     def dump(self):
 278         #print ElementTree.tostring(self.get_elements())
 279         ElementTree.dump(self.get_elements())
 280
 281     def get_elements(self):
 282         root = ElementTree.Element('Bustard',
 283                                    {'version': str(Bustard.XML_VERSION)})
 284         version = ElementTree.SubElement(root, Bustard.SOFTWARE_VERSION)
 285         version.text = self.version
 286         if self.time is not None:
 287             run_date = ElementTree.SubElement(root, Bustard.DATE)
 288             run_date.text = str(self.time)
 289         if self.user is not None:
 290             user = ElementTree.SubElement(root, Bustard.USER)
 291             user.text = self.user
 292         params = ElementTree.SubElement(root, Bustard.PARAMETERS)
 293
 294         # add phasing parameters
 295         for lane in LANE_LIST:
 296             if self.phasing.has_key(lane):
 297                 params.append(self.phasing[lane].get_elements())
 298
 299         # add crosstalk matrix if it exists
 300         if self.crosstalk is not None:
 301             root.append(self.crosstalk.get_elements())
 302
 303         # add bustard config if it exists
 304         if self.bustard_config is not None:
 305             root.append(self.bustard_config)
 306         return root
 307
 308     def set_elements(self, tree):
 309         if tree.tag != Bustard.BUSTARD:
 310             raise ValueError('Expected "Bustard" SubElements')
 311         xml_version = int(tree.attrib.get('version', 0))
 312         if xml_version > Bustard.XML_VERSION:
 313             LOGGER.warn('Bustard XML tree is a higher version than this class')
 314         for element in list(tree):
 315             if element.tag == Bustard.SOFTWARE_VERSION:
 316                 self._path_version = element.text
 317             elif element.tag == Bustard.DATE:
 318                 self.date = date.fromtimestamp(float(element.text))
 319             elif element.tag == Bustard.USER:
 320                 self.user = element.text
 321             elif element.tag == Bustard.PARAMETERS:
 322                 for param in element:
 323                     p = Phasing(xml=param)
 324                     self.phasing[p.lane] = p
 325             elif element.tag == CrosstalkMatrix.CROSSTALK:
 326                 self.crosstalk = CrosstalkMatrix(xml=element)
 327             elif element.tag == Bustard.BUSTARD_CONFIG:
 328                 self.bustard_config = element
 329             else:
 330                 raise ValueError("Unrecognized tag: %s" % (element.tag,))
 331
 332 def bustard(pathname):
 333     """
 334     Construct a Bustard object by analyzing an Illumina Bustard directory.
 335
 336     :Parameters:
 337       - `pathname`: A bustard directory
 338
 339     :Return:
 340       Fully initialized Bustard object.
 341     """
 342     pathname = os.path.abspath(pathname)
 343     bustard_filename = os.path.join(pathname, 'config.xml')
 344     demultiplexed_filename = os.path.join(pathname,
 345                                           'DemultiplexedBustardConfig.xml')
 346
 347     if os.path.exists(demultiplexed_filename):
 348         b = bustard_from_hiseq(pathname, demultiplexed_filename)
 349     elif os.path.exists(bustard_filename):
 350         b = bustard_from_ga2(pathname, bustard_filename)
 351     else:
 352         b = bustard_from_ga1(pathname)
 353
 354     return b
 355
 356 def bustard_from_ga1(pathname):
 357     """Initialize bustard class from ga1 era runfolders.
 358     """
 359     path, name = os.path.split(pathname)
 360
 361     groups = name.split("_")
 362     if len(groups) < 3:
 363         msg = "Not enough information to create attributes"\
 364               " from directory name: %s"
 365         LOGGER.error(msg % (pathname,))
 366         return None
 367
 368     b = Bustard()
 369     b.pathname = pathname
 370     b.update_attributes_from_pathname()
 371     version = re.search(VERSION_RE, groups[0])
 372     b._path_version = version.group(1)
 373     t = time.strptime(groups[1], EUROPEAN_STRPTIME)
 374     b.date = date(*t[0:3])
 375     b.user = groups[2]
 376
 377     # I only found these in Bustard1.9.5/1.9.6 directories
 378     if b.version in ('1.9.5', '1.9.6'):
 379         # at least for our runfolders for 1.9.5 and 1.9.6 matrix[1-8].txt are always the same
 380         crosstalk_file = os.path.join(pathname, "matrix1.txt")
 381         b.crosstalk = CrosstalkMatrix(crosstalk_file)
 382
 383     add_phasing(b)
 384     return b
 385
 386
 387 def bustard_from_ga2(pathname, config_filename):
 388     """Initialize bustard class from ga2-era runfolder
 389     Actually I don't quite remember if it is exactly the GA2s, but
 390     its after the original runfolder style and before the HiSeq.
 391     """
 392     # for version 1.3.2 of the pipeline the bustard version number went down
 393     # to match the rest of the pipeline. However there's now a nifty
 394     # new (useful) bustard config file.
 395
 396     # stub values
 397     b = Bustard()
 398     b.pathname = pathname
 399     b.update_attributes_from_pathname()
 400     bustard_config_root = ElementTree.parse(config_filename)
 401     b.bustard_config = bustard_config_root.getroot()
 402     b.crosstalk = crosstalk_matrix_from_bustard_config(b.pathname,
 403                                                        b.bustard_config)
 404     add_phasing(b)
 405
 406     return b
 407
 408 def bustard_from_hiseq(pathname, config_filename):
 409     b = Bustard()
 410     b.pathname = pathname
 411     bustard_config_root = ElementTree.parse(config_filename)
 412     b.bustard_config = bustard_config_root.getroot()
 413     add_phasing(b)
 414     return b
 415
 416 def add_phasing(bustard_obj):
 417     paramfiles = glob(os.path.join(bustard_obj.pathname,
 418                                    "params?.xml"))
 419     for paramfile in paramfiles:
 420         phasing = Phasing(paramfile)
 421         assert (phasing.lane >= 1 and phasing.lane <= 8)
 422         bustard_obj.phasing[phasing.lane] = phasing
 423
 424 def fromxml(tree):
 425     """
 426     Reconstruct a htsworkflow.pipelines.Bustard object from an xml block
 427     """
 428     b = Bustard()
 429     b.set_elements(tree)
 430     return b
 431
 432 def make_cmdline_parser():
 433     from optparse import OptionParser
 434     parser = OptionParser('%prog: bustard_directory')
 435     return parser
 436
 437 def main(cmdline):
 438     parser = make_cmdline_parser()
 439     opts, args = parser.parse_args(cmdline)
 440
 441     for bustard_dir in args:
 442         print u'analyzing bustard directory: ' + unicode(bustard_dir)
 443         bustard_object = bustard(bustard_dir)
 444         bustard_object.dump()
 445
 446         bustard_object2 = Bustard(xml=bustard_object.get_elements())
 447         print ('-------------------------------------')
 448         bustard_object2.dump()
 449         print ('=====================================')
 450         b1_tree = bustard_object.get_elements()
 451         b1 = ElementTree.tostring(b1_tree).split(os.linesep)
 452         b2_tree = bustard_object2.get_elements()
 453         b2 = ElementTree.tostring(b2_tree).split(os.linesep)
 454         for line1, line2 in zip(b1, b2):
 455             if b1 != b2:
 456                 print "b1: ", b1
 457                 print "b2: ", b2
 458
 459 if __name__ == "__main__":
 460     main(sys.argv[1:])