File: ReclusterByKmer.java

package info (click to toggle)
bbmap 39.20%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 26,024 kB
  • sloc: java: 312,743; sh: 18,099; python: 5,247; ansic: 2,074; perl: 96; makefile: 39; xml: 38
file content (586 lines) | stat: -rwxr-xr-x 16,431 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
package cluster;

import java.io.File;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Random;

import dna.Data;
import fileIO.ByteFile;
import fileIO.ByteFile1;
import fileIO.ByteFile2;
import fileIO.FileFormat;
import fileIO.ReadWrite;
import shared.Parse;
import shared.Parser;
import shared.PreParser;
import shared.Shared;
import shared.Timer;
import shared.Tools;
import stream.ConcurrentGenericReadInputStream;
import stream.ConcurrentReadInputStream;
import stream.ConcurrentReadOutputStream;
import stream.FASTQ;
import stream.FastaReadInputStream;
import stream.Read;
import structures.ListNum;

/**
 * @author Brian Bushnell
 * @date Feb 7, 2014
 *
 */
public class ReclusterByKmer {
	
	public static void main(String[] args){
		Timer t=new Timer();
		ReclusterByKmer x=new ReclusterByKmer(args);
		x.process(t);
		
		//Close the print stream if it was redirected
		Shared.closeStream(x.outstream);
	}
	
	public ReclusterByKmer(String[] args){
		
		{//Preparse block for help, config files, and outstream
			PreParser pp=new PreParser(args, getClass(), false);
			args=pp.args;
			outstream=pp.outstream;
		}
		
		boolean setInterleaved=false; //Whether it was explicitly set.
		
		ReadWrite.USE_PIGZ=ReadWrite.USE_UNPIGZ=true;
		
		
		int k1_=12;
		int k2_=3;
		Parser parser=new Parser();
		
		for(int i=0; i<args.length; i++){
			String arg=args[i];
			String[] split=arg.split("=");
			String a=split[0].toLowerCase();
			String b=split.length>1 ? split[1] : null;
			
			if(Parser.parseZip(arg, a, b)){
				//do nothing
			}else if(Parser.parseCommonStatic(arg, a, b)){
				//do nothing
			}else if(Parser.parseFasta(arg, a, b)){
				//do nothing
			}else if(Parser.parseQuality(arg, a, b)){
				//do nothing
			}else if(parser.parseInterleaved(arg, a, b)){
				//do nothing
			}else if(parser.parseFiles(arg, a, b)){
				//do nothing
			}else if(parser.parseCommon(arg, a, b)){
				//do nothing
			}else if(a.equals("verbose")){
				verbose=Parse.parseBoolean(b);
				ByteFile1.verbose=verbose;
				ByteFile2.verbose=verbose;
				stream.FastaReadInputStream.verbose=verbose;
				ConcurrentGenericReadInputStream.verbose=verbose;
				stream.FastqReadInputStream.verbose=verbose;
				ReadWrite.verbose=verbose;
			}else if(a.equals("build") || a.equals("genome")){
				Data.setGenome(Integer.parseInt(b));
			}else if(in1==null && i==0 && Tools.looksLikeInputStream(arg)){
				in1=arg;
			}else{
				System.err.println("Unknown parameter "+args[i]);
				assert(false) : "Unknown parameter "+args[i];
				//				throw new RuntimeException("Unknown parameter "+args[i]);
			}
		}
		
		{//Process parser fields
			Parser.processQuality();
			
			maxReads=parser.maxReads;
			overwrite=parser.overwrite;
			append=parser.append;
			
			setInterleaved=parser.setInterleaved;
			
			in1=parser.in1;
			in2=parser.in2;
//			qfin1=parser.qfin1;
//			qfin2=parser.qfin2;

			out1=parser.out1;
			out2=parser.out2;
//			qfout1=parser.qfout1;
//			qfout2=parser.qfout2;
			
			extin=parser.extin;
			extout=parser.extout;
		}
		
		
		if(in1!=null && in2==null && in1.indexOf('#')>-1 && !new File(in1).exists()){
			in2=in1.replace("#", "2");
			in1=in1.replace("#", "1");
		}
		if(out1!=null && out2==null && out1.indexOf('#')>-1){
			out2=out1.replace("#", "2");
			out1=out1.replace("#", "1");
		}
		if(in2!=null){
			if(FASTQ.FORCE_INTERLEAVED){System.err.println("Reset INTERLEAVED to false because paired input files were specified.");}
			FASTQ.FORCE_INTERLEAVED=FASTQ.TEST_INTERLEAVED=false;
		}
		
		assert(FastaReadInputStream.settingsOK());
		
		if(in1==null){throw new RuntimeException("Error - at least one input file is required.");}
		if(!ByteFile.FORCE_MODE_BF1 && !ByteFile.FORCE_MODE_BF2 && Shared.threads()>2){
//			if(ReadWrite.isCompressed(in1)){ByteFile.FORCE_MODE_BF2=true;}
			ByteFile.FORCE_MODE_BF2=true;
		}
		
		if(out1==null && out2!=null){throw new RuntimeException("Error - cannot define out2 without defining out1.");}
		
		if(!setInterleaved){
			assert(in1!=null && (out1!=null || out2==null)) : "\nin1="+in1+"\nin2="+in2+"\nout1="+out1+"\nout2="+out2+"\n";
			if(in2!=null){ //If there are 2 input streams.
				FASTQ.FORCE_INTERLEAVED=FASTQ.TEST_INTERLEAVED=false;
				outstream.println("Set INTERLEAVED to "+FASTQ.FORCE_INTERLEAVED);
			}else{ //There is one input stream.
				if(out2!=null){
					FASTQ.FORCE_INTERLEAVED=true;
					FASTQ.TEST_INTERLEAVED=false;
					outstream.println("Set INTERLEAVED to "+FASTQ.FORCE_INTERLEAVED);
				}
			}
		}

		if(out1!=null && out1.equalsIgnoreCase("null")){out1=null;}
		if(out2!=null && out2.equalsIgnoreCase("null")){out2=null;}
		
		if(!Tools.testOutputFiles(overwrite, append, false, out1, out2)){
			throw new RuntimeException("\n\noverwrite="+overwrite+"; Can't write to output files "+out1+", "+out2+"\n");
		}
		
		ffout1=FileFormat.testOutput(out1, FileFormat.FASTQ, extout, true, overwrite, append, false);
		ffout2=FileFormat.testOutput(out2, FileFormat.FASTQ, extout, true, overwrite, append, false);

		ffin1=FileFormat.testInput(in1, FileFormat.FASTQ, extin, true, true);
		ffin2=FileFormat.testInput(in2, FileFormat.FASTQ, extin, true, true);

		/* Check for output file collisions */
		Tools.testOutputFiles(overwrite, append, false, out1, out2);

		k1=k1_;
		assert(k1>=-1 && k1<=15) : "k1 must lie between 1 and 15, inclusive (0 to disable)";
		k2=k2_;
		assert(k2>=-1 && k2<=6) : "k2 must lie between 1 and 6, inclusive (0 to disable)";

		arraylen1=(k1>0 ? ClusterTools.maxCanonicalKmer(k1)+1 : 0);
		arraylen2=(k2>0 ? ClusterTools.maxCanonicalKmer(k2)+1 : 0);
	}
	
	/*--------------------------------------------------------------*/
	
	void process(Timer t){
		
		
		final ConcurrentReadInputStream cris;
		{
			cris=ConcurrentReadInputStream.getReadInputStream(maxReads, true, ffin1, ffin2, null, null);
			if(verbose){System.err.println("Started cris");}
			cris.start(); //4567
		}
		boolean paired=cris.paired();
		if(verbose){System.err.println("Input is "+(paired ? "paired" : "unpaired"));}

		ConcurrentReadOutputStream ros=null;
		if(out1!=null){
			final int buff=4;
			
			if(cris.paired() && out2==null && (in1==null || !in1.contains(".sam"))){
				outstream.println("Writing interleaved.");
			}

			assert(!out1.equalsIgnoreCase(in1) && !out1.equalsIgnoreCase(in1)) : "Input file and output file have same name.";
			assert(out2==null || (!out2.equalsIgnoreCase(in1) && !out2.equalsIgnoreCase(in2))) : "out1 and out2 have same name.";
			
			ros=ConcurrentReadOutputStream.getStream(ffout1, ffout2, null, null, buff, null, false);
			ros.start();
		}
		
		long readsProcessed=0;
		long basesProcessed=0;
		
		{
			
			ListNum<Read> ln=cris.nextList();
			ArrayList<Read> reads=(ln!=null ? ln.list : null);
			
//			System.err.println("Fetched "+reads);
			
			if(reads!=null && !reads.isEmpty()){
				Read r=reads.get(0);
				assert((ffin1==null || ffin1.samOrBam()) || (r.mate!=null)==cris.paired());
			}

			while(ln!=null && reads!=null && reads.size()>0){//ln!=null prevents a compiler potential null access warning

				for(int idx=0; idx<reads.size(); idx++){
					final Read r1=reads.get(idx);
					final Read r2=r1.mate;
					
					{
						readsProcessed++;
						basesProcessed+=r1.length();
					}
					if(r2!=null){
						readsProcessed++;
						basesProcessed+=r2.length();
					}
					
					
					boolean remove=false;
					if(remove){reads.set(idx, null);}
				}
				
				if(ros!=null){ros.add(reads, ln.id);}

				cris.returnList(ln);
				ln=cris.nextList();
				reads=(ln!=null ? ln.list : null);
			}
			if(ln!=null){
				cris.returnList(ln.id, ln.list==null || ln.list.isEmpty());
			}
		}
		
		errorState|=ReadWrite.closeStreams(cris, ros);
		
		t.stop();
		outstream.println(Tools.timeReadsBasesProcessed(t, readsProcessed, basesProcessed, 8));
		
		if(errorState){
			throw new RuntimeException("ReformatReads terminated in an error state; the output may be corrupt.");
		}
	}
	
	/*--------------------------------------------------------------*/
	
	Cluster fetchCluster(int x){
		if(x>clusterList.size()){
			synchronized(clusterList){
				clusterList.ensureCapacity(2*x);
				for(int i=clusterList.size(); i<x; i++){
					clusterList.add(new Cluster(i, k1, k2, arraylen1, arraylen2));
				}
				clusterList.notifyAll();
			}
		}
		Cluster c=clusterList.get(x);
		while(c==null){
			synchronized(clusterList){
				c=clusterList.get(x);
				assert(c!=null);
			}
		}
		return c;
	}
	
	/**
	 * Creates clusters; Generates kmer spectra for clusters
	 * @param t
	 */
	private void findKmerSpectra(Timer t){
		
		/* Create read input stream */
		final ConcurrentReadInputStream cris;
		{
			cris=ConcurrentReadInputStream.getReadInputStream(maxReads, true, ffin1, ffin2);
			cris.start(); //4567
			if(verbose){System.err.println("Started cris");}
		}
		
		/* Create ClusterThreads */
		ArrayList<ClusterThread> alct=new ArrayList<ClusterThread>(THREADS);
		
		for(int i=0; i<THREADS; i++){alct.add(new ClusterThread(i, CLUSTER_MODE_CREATE, -1, cris));}
		for(ClusterThread ct : alct){ct.start();}

		long readsIn=0, basesIn=0;
		
		/* Wait for threads to die, and gather statistics */
		for(ClusterThread ct : alct){
			while(ct.getState()!=Thread.State.TERMINATED){
				try {
					ct.join();
				} catch (InterruptedException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
			}
			readsIn+=ct.readsInT;
			basesIn+=ct.basesInT;
		}
		
		/* Shut down I/O streams; capture error status */
		errorState|=ReadWrite.closeStreams(cris);
	}
	
	/**
	 * Assign reads to clusters using additional kmer information.
	 * @param t
	 */
	private void recluster(Timer t){
		
		/* Create read input stream */
		final ConcurrentReadInputStream cris;
		{
			cris=ConcurrentReadInputStream.getReadInputStream(maxReads, true, ffin1, ffin2);
			cris.start(); //4567
			if(verbose){System.err.println("Started cris");}
		}
		
		/* Create ClusterThreads */
		ArrayList<ClusterThread> alct=new ArrayList<ClusterThread>(THREADS);
		for(int i=0; i<THREADS; i++){alct.add(new ClusterThread(i, CLUSTER_MODE_RECLUSTER, ambigMode, cris));}
		for(ClusterThread ct : alct){ct.start();}
		
		long readsIn=0, basesIn=0;
		
		/* Wait for threads to die, and gather statistics */
		for(ClusterThread ct : alct){
			while(ct.getState()!=Thread.State.TERMINATED){
				try {
					ct.join();
				} catch (InterruptedException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
			}
			readsIn+=ct.readsInT;
			basesIn+=ct.basesInT;
		}
		
		/* Shut down I/O streams; capture error status */
		errorState|=ReadWrite.closeStreams(cris);
	}
	
	/*--------------------------------------------------------------*/
	
	private class ClusterThread extends Thread{
		
		public ClusterThread(int id_, int clusterMode_, int ambigMode_, ConcurrentReadInputStream cris_){
			id=id_;
			ambigModeT=ambigMode_;
			clusterMode=clusterMode_;
			cris=cris_;
		}
		
		@Override
		public void run(){
			randy=(ambigModeT==AMBIG_MODE_RAND) ? Shared.threadLocalRandom() : null;
			
			ListNum<Read> ln=cris.nextList();
			ArrayList<Read> reads=(ln!=null ? ln.list : null);
			
			//While there are more reads lists...
			while(ln!=null && reads!=null && reads.size()>0){//ln!=null prevents a compiler potential null access warning
				
				//For each read (or pair) in the list...
				for(int i=0; i<reads.size(); i++){
					processRead(reads.get(i));
				}
				
				//Fetch a new read list
				cris.returnList(ln);
				ln=cris.nextList();
				reads=(ln!=null ? ln.list : null);
			}
			cris.returnList(ln);
		}
		
		
		private void processRead(final Read r1){
			final Read r2=r1.mate;

			if(verbose){System.err.println("Considering read "+r1.id+" "+new String(r1.bases));}

			readsInT++;
			basesInT+=r1.length();
			if(r2!=null){
				readsInT++;
				basesInT+=r2.length();
			}

			final ReadTag rt1=new ReadTag(r1);
			final ReadTag rt2=(r2==null ? null : new ReadTag(r2));

			r1.obj=rt1;
			if(r2!=null){r2.obj=rt2;}

			if(clusterMode==CLUSTER_MODE_CREATE){
				addToCluster(r1, r2, rt1, rt2);
			}else if(clusterMode==CLUSTER_MODE_RECLUSTER){
				reCluster(r1, r2, rt1, rt2);
			}else{
				throw new RuntimeException("Unknown mode "+clusterMode);
			}
		}
		
		private void addToCluster(Read r1, Read r2, ReadTag rt1, ReadTag rt2){
			final int cn1=rt1.cluster0;
			final int cn2=rt2==null ? cn1 : rt2.cluster0;
			if(cn1==cn2){
				Cluster c1=fetchCluster(cn1);
				c1.add(r1);
				c1.add(r2);
			}else{
				Cluster c1=fetchCluster(cn1);
				Cluster c2=fetchCluster(cn2);
				c1.add(r1);
				c1.add(r2);
				c2.add(r1);
				c2.add(r2);
			}
		}
		
		private void reCluster(Read r1, Read r2, ReadTag rt1, ReadTag rt2){

			assert(false) : "TODO";

			Cluster bestCluster1=null;
			Cluster bestCluster2=null;

			float bestScore1=-999999999, bestScore1_2=-999999999;
			float bestScore2=-999999999, bestScore2_1=-999999999;

			for(Cluster c : clusterList){

				float score1=c.score(r1);
				float score2=c.score(r2);

				if(bestCluster1==null || score1>bestScore1){
					bestCluster1=c;
					bestScore1=score1;
					bestScore1_2=score2;
				}
				if(bestCluster2==null || score2>bestScore2){
					bestCluster2=c;
					bestScore2=score2;
					bestScore2_1=score1;
				}
			}

			if(r2==null){
				rt1.cluster1=bestCluster1.id;
			}else if(bestCluster1==bestCluster2){
				rt1.cluster1=rt2.cluster1=bestCluster1.id;
			}else{
				assert(r1!=null && r2!=null && bestCluster1!=bestCluster2);

				float a=bestScore1+bestScore1_2;
				float b=bestScore2+bestScore2_1;

				if(ambigModeT==AMBIG_MODE_BEST){
					if(a>=b){
						rt1.cluster1=rt2.cluster1=bestCluster1.id;
					}else{
						rt1.cluster1=rt2.cluster1=bestCluster2.id;
					}
				}else if(ambigModeT==AMBIG_MODE_BOTH){
					assert(false) : "TODO";
				}else if(ambigModeT==AMBIG_MODE_TOSS){
					rt1.cluster1=rt2.cluster1=-1;
				}else if(ambigModeT==AMBIG_MODE_RAND){
					if(a<0 || b<0){
						float c=0-(Tools.min(a, b))*1.5f;
						a=a+c;
						b=a+c;
					}
					float coin=randy.nextFloat()*(a+b);
					if(coin<=a){
						rt1.cluster1=rt2.cluster1=bestCluster1.id;
					}else{
						rt1.cluster1=rt2.cluster1=bestCluster2.id;
					}
				}
			}

		}

		final int id;
		final int clusterMode;
		final int ambigModeT;
		final ConcurrentReadInputStream cris;
		
		Random randy;
		
		long readsInT;
		long basesInT;
		
	}
	
	/*--------------------------------------------------------------*/
	
	/*--------------------------------------------------------------*/
	
	/*--------------------------------------------------------------*/
	
	/*--------------------------------------------------------------*/
	
	public boolean errorState=false;
	
	final ArrayList<Cluster> clusterList=new ArrayList<Cluster>(256);
	
	/** 'big' kmer */
	public final int k1;
	/** 'small' kmer */
	public final int k2;

	public final int arraylen1;
	public final int arraylen2;
	
	private String in1=null;
	private String in2=null;

	private String out1=null;
	private String out2=null;
	
	private String extin=null;
	private String extout=null;
	
	private boolean overwrite=true;
	private boolean append=false;
	
	private long maxReads=-1;
	
	private int ambigMode=AMBIG_MODE_RAND;
	
	private final FileFormat ffin1;
	private final FileFormat ffin2;
	
	private final FileFormat ffout1;
	private final FileFormat ffout2;
	
	private PrintStream outstream=System.err;
	
	private int THREADS=Shared.threads();
	
	/*--------------------------------------------------------------*/

	public static boolean verbose=false;

	public static final int CLUSTER_MODE_CREATE=0;
	public static final int CLUSTER_MODE_RECLUSTER=1;
	public static final int CLUSTER_MODE_REFINE=2;
	
	public static final int AMBIG_MODE_BEST=0;
	public static final int AMBIG_MODE_BOTH=1;
	public static final int AMBIG_MODE_TOSS=2;
	public static final int AMBIG_MODE_RAND=3;
	
}