Add support for first-gen HiSeq flowcells (e.g. ABXX)
[htsworkflow.git] / htsworkflow / pipelines / test / simulate_runfolder.py
index 5b79c2ea19ee4e12a250fed9026c1792722bda6c..0b06c0bdfe56b2ca0d82472dd9226c5f105e8f53 100644 (file)
@@ -9,14 +9,18 @@ TEST_CODE_DIR = os.path.split(__file__)[0]
 TESTDATA_DIR = os.path.join(TEST_CODE_DIR, 'testdata')
 LANE_LIST = range(1,9)
 TILE_LIST = range(1,101)
+HISEQ_TILE_LIST = [1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108,
+                   1201, 1202, 1203, 1204, 1205, 1206, 1207, 1208,
+                   2101, 2102, 2103, 2104, 2105, 2106, 2107, 2108,
+                   2201, 2202, 2203, 2204, 2205, 2206, 2207, 2208,]
 
 def make_firecrest_dir(data_dir, version="1.9.2", start=1, stop=37):
-    firecrest_dir = os.path.join(data_dir, 
+    firecrest_dir = os.path.join(data_dir,
                                  'C%d-%d_Firecrest%s_12-04-2008_diane' % (start, stop, version)
                                  )
     os.mkdir(firecrest_dir)
     return firecrest_dir
-    
+
 def make_ipar_dir(data_dir, version='1.01'):
     """
     Construct an artificial ipar parameter file and directory
@@ -58,7 +62,7 @@ def make_rta_intensities_1460(data_dir, version='1.4.6.0'):
     intensities_dir = os.path.join(data_dir, 'Intensities')
     if not os.path.exists(intensities_dir):
       os.mkdir(intensities_dir)
+
     param_file = os.path.join(TESTDATA_DIR, 'rta_intensities_config.xml')
     shutil.copy(param_file, os.path.join(intensities_dir, 'config.xml'))
 
@@ -71,7 +75,7 @@ def make_rta_basecalls_1460(intensities_dir):
     basecalls_dir = os.path.join(intensities_dir, 'BaseCalls')
     if not os.path.exists(basecalls_dir):
       os.mkdir(basecalls_dir)
+
     param_file = os.path.join(TESTDATA_DIR, 'rta_basecalls_config.xml')
     shutil.copy(param_file, os.path.join(basecalls_dir, 'config.xml'))
 
@@ -84,12 +88,25 @@ def make_rta_intensities_1870(data_dir, version='1.8.70.0'):
     intensities_dir = os.path.join(data_dir, 'Intensities')
     if not os.path.exists(intensities_dir):
       os.mkdir(intensities_dir)
+
     param_file = os.path.join(TESTDATA_DIR, 'rta_intensities_config_1870.xml')
     shutil.copy(param_file, os.path.join(intensities_dir, 'config.xml'))
 
     return intensities_dir
 
+def make_rta_intensities_1_10(data_dir, version='1.10.36.0'):
+    """
+    Construct an artificial RTA Intensities parameter file and directory
+    """
+    intensities_dir = os.path.join(data_dir, 'Intensities')
+    if not os.path.exists(intensities_dir):
+      os.mkdir(intensities_dir)
+
+    param_file = os.path.join(TESTDATA_DIR, 'rta_intensities_config_1.10.xml')
+    shutil.copy(param_file, os.path.join(intensities_dir, 'config.xml'))
+
+    return intensities_dir
+
 def make_rta_basecalls_1870(intensities_dir):
     """
     Construct an artificial RTA Intensities parameter file and directory
@@ -97,35 +114,58 @@ def make_rta_basecalls_1870(intensities_dir):
     basecalls_dir = os.path.join(intensities_dir, 'BaseCalls')
     if not os.path.exists(basecalls_dir):
       os.mkdir(basecalls_dir)
+
     param_file = os.path.join(TESTDATA_DIR, 'rta_basecalls_config_1870.xml')
     shutil.copy(param_file, os.path.join(basecalls_dir, 'config.xml'))
 
     return basecalls_dir
 
-def make_qseqs(bustard_dir, in_temp=True):
+def make_rta_basecalls_1_10(intensities_dir):
+    """
+    Construct an artificial RTA Intensities parameter file and directory
+    """
+    basecalls_dir = os.path.join(intensities_dir, 'BaseCalls')
+    if not os.path.exists(basecalls_dir):
+        os.mkdir(basecalls_dir)
+
+    make_qseqs(basecalls_dir, basecall_info=ABXX_BASE_CALL_INFO)
+    param_file = os.path.join(TESTDATA_DIR, 'rta_basecalls_config_1.10.xml')
+    shutil.copy(param_file, os.path.join(basecalls_dir, 'config.xml'))
+
+    return basecalls_dir
+
+def make_qseqs(bustard_dir, in_temp=True, basecall_info=None):
     """
     Fill gerald directory with qseq files
     """
+    if basecall_info is None:
+        qseq_file = '42BRJAAXX_8_1_0039_qseq.txt'
+        tile_list = TILE_LIST
+        summary_file = '42BRJAAXX_BustardSummary.xml'
+    else:
+        qseq_file = basecall_info.qseq_file
+        tile_list = basecall_info.tile_list
+        summary_file = basecall_info.basecall_summary
+
     # 42BRJ 8 1 0039 happened to be a better than usual tile, in that there
     # was actually sequence at the start
-    source = os.path.join(TESTDATA_DIR, '42BRJAAXX_8_1_0039_qseq.txt')
+    source = os.path.join(TESTDATA_DIR, qseq_file)
     destdir = bustard_dir
     if not os.path.isdir(destdir):
         os.mkdir(destdir)
-        
+
     for lane in LANE_LIST:
-        for tile in TILE_LIST:
+        for tile in tile_list:
             destination = os.path.join(bustard_dir, 's_%d_1_%04d_qseq.txt' % (lane, tile))
             shutil.copy(source, destination)
 
     make_matrix_dir(bustard_dir)
     make_phasing_dir(bustard_dir)
 
-    summary_source = os.path.join(TESTDATA_DIR, '42BRJAAXX_BustardSummary.xml')
+    summary_source = os.path.join(TESTDATA_DIR, summary_file)
     summary_dest = os.path.join(bustard_dir, 'BustardSummary.xml')
     shutil.copy(summary_source, summary_dest)
-    
+
     return destdir
 
 def make_scores(gerald_dir, in_temp=True):
@@ -139,29 +179,29 @@ def make_scores(gerald_dir, in_temp=True):
         destdir = os.path.join(destdir, 'Temp')
     if not os.path.isdir(destdir):
         os.mkdir(destdir)
-        
+
     for lane in LANE_LIST:
         for tile in TILE_LIST:
             destination = os.path.join(destdir, 's_%d_%04d_score.txt' % (lane, tile))
             shutil.copy(source, destination)
-            
+
     return destdir
 
 def make_matrix_dir(bustard_dir):
     """
     Create several matrix files in <bustard_dir>/Matrix/
 
-    from pipeline 1.4    
+    from pipeline 1.4
     """
     destdir = os.path.join(bustard_dir, 'Matrix')
     if not os.path.isdir(destdir):
         os.mkdir(destdir)
-        
+
     source = os.path.join(TESTDATA_DIR, '42BRJAAXX_8_02_matrix.txt')
     for lane in LANE_LIST:
         destination = os.path.join(destdir, 's_%d_02_matrix.txt' % ( lane, ))
         shutil.copy(source, destination)
-        
+
 def make_matrix(matrix_filename):
     contents = """# Auto-generated frequency response matrix
 > A
@@ -184,13 +224,13 @@ def make_matrix_dir_rta160(bustard_dir):
     destdir = os.path.join(bustard_dir, 'Matrix')
     if not os.path.isdir(destdir):
         os.mkdir(destdir)
-        
+
     source = os.path.join(TESTDATA_DIR, '61MMFAAXX_4_1_matrix.txt')
     lane_fragments = [ "_%d" % (l,) for l in LANE_LIST]
     for fragment in lane_fragments:
         destination = os.path.join(destdir, 's%s_1_matrix.txt' % ( fragment, ))
         shutil.copy(source, destination)
-        
+
 def make_phasing_dir(bustard_dir):
     """
     Create several phasing files in <bustard_dir>/Phasing/
@@ -200,12 +240,12 @@ def make_phasing_dir(bustard_dir):
     destdir = os.path.join(bustard_dir, 'Phasing')
     if not os.path.isdir(destdir):
         os.mkdir(destdir)
-        
+
     source = os.path.join(TESTDATA_DIR, '42BRJAAXX_8_01_phasing.xml')
     for lane in LANE_LIST:
         destination = os.path.join(destdir, 's_%d_01_phasing.xml' % ( lane, ))
         shutil.copy(source, destination)
-    
+
 def make_phasing_params(bustard_dir):
     for lane in LANE_LIST:
         pathname = os.path.join(bustard_dir, 'params%d.xml' % (lane))
@@ -227,6 +267,11 @@ def make_gerald_config_100(gerald_dir):
     destination = os.path.join(gerald_dir, 'config.xml')
     shutil.copy(source, destination)
 
+def make_gerald_config_1_10(gerald_dir):
+    source = os.path.join(TESTDATA_DIR, 'gerald_config_1.10.xml')
+    destination = os.path.join(gerald_dir, 'config.xml')
+    shutil.copy(source, destination)
+
 def make_summary_htm_100(gerald_dir):
     source = os.path.join(TESTDATA_DIR, 'Summary-pipeline100.htm')
     destination = os.path.join(gerald_dir, 'Summary.htm')
@@ -252,6 +297,13 @@ def make_summary_rta160_xml(gerald_dir):
     destination = os.path.join(gerald_dir, 'Summary.xml')
     shutil.copy(source, destination)
 
+
+def make_summary_rta1_10_xml(gerald_dir):
+    source = os.path.join(TESTDATA_DIR, 'Summary-rta1.10.xml')
+    destination = os.path.join(gerald_dir, 'Summary.xml')
+    shutil.copy(source, destination)
+
+
 def make_eland_results(gerald_dir):
     eland_result = """>HWI-EAS229_24_207BTAAXX:1:7:599:759    ACATAGNCACAGACATAAACATAGACATAGAC U0      1       1       3       chrUextra.fa    28189829        R       D.
 >HWI-EAS229_24_207BTAAXX:1:7:205:842    AAACAANNCTCCCAAACACGTAAACTGGAAAA  U1      0       1       0       chr2L.fa        8796855 R       DD      24T
@@ -273,7 +325,7 @@ def make_eland_multi(gerald_dir, paired=False, lane_list=LANE_LIST):
 >HWI-EAS229_60_30DP9AAXX:1:1:931:747    AAAAAAGCAAATTTCATTCACATGTTCTGTGTTCATA   1:0:0   spike.fa/sample1:55269838R0
 >HWI-EAS229_60_30DP9AAXX:1:1:931:747    AAAAAAGCAAATTTCATTCACATGTTCTGTGTTCATA   1:0:0   spike.fa/sample2:55269838R0
 """, """>HWI-EAS229_60_30DP9AAXX:1:1:1221:788   AAGATATCTACGACGTGGTATGGCGGTGTCTGGTCGT      NM
->HWI-EAS229_60_30DP9AAXX:1:1:1221:788   NNNNNNNNNNNNNNGTGGTATGGCGGTGTCTGGTCGT     QC 
+>HWI-EAS229_60_30DP9AAXX:1:1:1221:788   NNNNNNNNNNNNNNGTGGTATGGCGGTGTCTGGTCGT     QC
 >HWI-EAS229_60_30DP9AAXX:1:1:931:747    AAAAAAGCAAATTTCATTCACATGTTCTGTGTTCATA   1:0:2   chr5.fa:55269838R0
 >HWI-EAS229_60_30DP9AAXX:1:1:1121:379   AGAAGAGACATTAAGAGTTCCTGAAATTTATATCTGG   2:1:0   chr16.fa:46189180R1,chr7.fa:122968519R0,chr8.fa:48197174F0,chr7.fa:22516603F1,chr9.fa:134886204R
 >HWI-EAS229_60_30DP9AAXX:1:1:892:1155   ACATTCTCCTTTCCTTCTGAAGTTTTTACGATTCTTT   0:9:10  chr10.fa:114298201F1,chr12.fa:8125072F1,19500297F2,42341293R2,chr13.fa:27688155R2,95069772R1,chr15.fa:51016475F2,chr16.fa:27052155F2,chr1.fa:192426217R2,chr21.fa:23685310R2,chr2.fa:106680068F1,chr3.fa:185226695F2,chr4.fa:106626808R2,chr5.fa:14704894F1,43530779F1,126543189F2,chr6.fa:74284101F1
@@ -339,3 +391,16 @@ _bbbbbaaababaabbbbab]D]aaaaaaaaaaaaaa
         f.close()
 
 
+class BaseCallInfo(object):
+    """Provide customization for how to setup the base call mock data
+    """
+    def __init__(self, qseq_file, tile_list, basecall_summary):
+        self.qseq_file = qseq_file
+        self.tile_list = tile_list
+        self.basecall_summary = basecall_summary
+
+# First generation HiSeq Flowcell
+ABXX_BASE_CALL_INFO = BaseCallInfo(
+    qseq_file='AA01CCABXX_8_2_2207_qseq.txt',
+    tile_list = HISEQ_TILE_LIST,
+    basecall_summary = 'AA01CCABXX_BustardSummary.xml')