File: AnalyzeBarcodes.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 (366 lines) | stat: -rwxr-xr-x 12,004 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
package barcode;

import java.io.PrintStream;
import java.util.Collections;

import fileIO.ByteFile;
import fileIO.ByteFile1;
import fileIO.ByteFile2;
import fileIO.ByteStreamWriter;
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 structures.ByteBuilder;

/**
 * Analyzes paired barcode counts.
 * This is the output file from CountBarcodes2.
 * Example: TODO
 * 
 * @author Brian Bushnell
 * @date July 19, 2023
 *
 */
public class AnalyzeBarcodes {
	
	/*--------------------------------------------------------------*/
	/*----------------        Initialization        ----------------*/
	/*--------------------------------------------------------------*/
	
	/**
	 * Code entrance from the command line.
	 * @param args Command line arguments
	 */
	public static void main(String[] args){
		//Start a timer immediately upon code entrance.
		Timer t=new Timer();
		
		//Create an instance of this class
		AnalyzeBarcodes x=new AnalyzeBarcodes(args);
		
		//Run the object
		x.process(t);
		
		//Close the print stream if it was redirected
		Shared.closeStream(x.outstream);
	}
	
	/**
	 * Constructor.
	 * @param args Command line arguments
	 */
	public AnalyzeBarcodes(String[] args){
		
		{//Preparse block for help, config files, and outstream
			PreParser pp=new PreParser(args, /*getClass()*/null, false);
			args=pp.args;
			outstream=pp.outstream;
		}
		
		//Set shared static variables prior to parsing
		ReadWrite.USE_PIGZ=ReadWrite.USE_UNPIGZ=true;
		ReadWrite.setZipThreads(Shared.threads());
		
		{//Parse the arguments
			final Parser parser=parse(args);
			overwrite=parser.overwrite;
			append=parser.append;
			
			in1=parser.in1;
		}

		validateParams();
		fixExtensions(); //Add or remove .gz or .bz2 as needed
		checkFileExistence(); //Ensure files can be read and written
		checkStatics(); //Adjust file-related static fields as needed for this program

		ffin1=FileFormat.testInput(in1, FileFormat.TXT, null, true, true);
	}
	
	/*--------------------------------------------------------------*/
	/*----------------    Initialization Helpers    ----------------*/
	/*--------------------------------------------------------------*/
	
	/** Parse arguments from the command line */
	private Parser parse(String[] args){
		
		//Create a parser object
		Parser parser=new Parser();
		
		//Set any necessary Parser defaults here
		//parser.foo=bar;
//		parser.out1="stdout";
		
		//Parse each argument
		for(int i=0; i<args.length; i++){
			String arg=args[i];
			
			//Break arguments into their constituent parts, in the form of "a=b"
			String[] split=arg.split("=");
			String a=split[0].toLowerCase();
			String b=split.length>1 ? split[1] : null;
			if(b!=null && b.equalsIgnoreCase("null")){b=null;}

			if(a.equals("lines")){
				maxLines=Long.parseLong(b);
				if(maxLines<0){maxLines=Long.MAX_VALUE;}
			}else if(a.equals("verbose")){
				verbose=Parse.parseBoolean(b);
				ByteFile1.verbose=verbose;
				ByteFile2.verbose=verbose;
				ReadWrite.verbose=verbose;
			}else if(a.equals("expected") || a.equals("expectedbarcodes")){
				if(Tools.isNumeric(b)) {
					expectedBarcodeCount=Integer.parseInt(b);
				}else {
					expectedBarcodeFile=b;
				}
			}else if(a.equals("outleft") || a.equals("left") || a.equals("leftstats")){
				outLeft=b;
			}else if(a.equals("outright") || a.equals("right") || a.equals("rightstats")){
				outRight=b;
			}else if(a.equals("outpair") || a.equals("pair") || a.equals("pairstats")){
				outPair=b;
			}else if(a.equals("parse_flag_goes_here")){
				long fake_variable=Parse.parseKMG(b);
				//Set a variable here
			}else if(parser.parse(arg, a, b)){
				//do nothing
			}else{
				outstream.println("Unknown parameter "+args[i]);
				assert(false) : "Unknown parameter "+args[i];
				throw new RuntimeException("Unknown parameter "+args[i]);
			}
		}
		
		return parser;
	}
	
	/** Add or remove .gz or .bz2 as needed */
	private void fixExtensions(){
		in1=Tools.fixExtension(in1);
		if(in1==null){throw new RuntimeException("Error - at least one input file is required.");}
	}
	
	/** Ensure files can be read and written */
	private void checkFileExistence(){
		//Ensure output files can be written
		if(!Tools.testOutputFiles(overwrite, append, false, outLeft, outRight, outPair)){
//			outstream.println((out1==null)+", "+out1);
			throw new RuntimeException("\n\noverwrite="+overwrite+"; Can't write to some output files.\n");
		}
		
		//Ensure input files can be read
		if(!Tools.testInputFiles(false, true, in1, expectedBarcodeFile)){
			throw new RuntimeException("\nCan't read some input files.\n");  
		}
		
		//Ensure that no file was specified multiple times
		if(!Tools.testForDuplicateFiles(true, in1, expectedBarcodeFile, outLeft, outRight, outPair)){
			throw new RuntimeException("\nSome file names were specified multiple times.\n");
		}
	}
	
	/** Adjust file-related static fields as needed for this program */
	private static void checkStatics(){
		//Adjust the number of threads for input file reading
		if(!ByteFile.FORCE_MODE_BF1 && !ByteFile.FORCE_MODE_BF2 && Shared.threads()>2){
			ByteFile.FORCE_MODE_BF2=true;
		}
		
//		if(!ByteFile.FORCE_MODE_BF2){
//			ByteFile.FORCE_MODE_BF2=false;
//			ByteFile.FORCE_MODE_BF1=true;
//		}
	}
	
	/** Ensure parameter ranges are within bounds and required parameters are set */
	private boolean validateParams(){
//		assert(minfoo>0 && minfoo<=maxfoo) : minfoo+", "+maxfoo;
		assert(in1!=null && expectedBarcodeFile!=null) : "Barcode stats and expected barcodes must be specified.";
		return true;
	}
	
	/*--------------------------------------------------------------*/
	/*----------------         Outer Methods        ----------------*/
	/*--------------------------------------------------------------*/

	/** Create streams and process all data */
	void process(Timer t){
		
		bs=BarcodeStats.loadStatic(in1, expectedBarcodeFile, expectedBarcodeCount);
		linesProcessed+=bs.linesProcessed;
		bytesProcessed+=bs.bytesProcessed;
		bs.leftStats=bs.makeLeft();
		bs.rightStats=bs.makeRight();
		bs.calcStats();
		bs.leftStats.calcStats();
		bs.rightStats.calcStats();

//		float errorFraction1=bs.leftStats.errorFraction();
		float badPairFraction=bs.badPairFraction;
		
//		HashMap<String, Barcode> leftBadPairs
		
		if(outLeft!=null){
			ByteStreamWriter bsw=makeBSW(outLeft);
			printMismatchVsTotal(bs.leftStats, bsw);
			if(bsw!=null){errorState|=bsw.poisonAndWait();}
		}
		
		if(outRight!=null){
			ByteStreamWriter bsw=makeBSW(outRight);
			printMismatchVsTotal(bs.rightStats, bsw);
			if(bsw!=null){errorState|=bsw.poisonAndWait();}
		}
		
		if(outPair!=null){
			ByteStreamWriter bsw=makeBSW(outPair);
			printActualVsExpected(bs, bsw);
			if(bsw!=null){errorState|=bsw.poisonAndWait();}
		}
		
		t.stop();
		
		outstream.println(Tools.timeLinesBytesProcessed(t, linesProcessed, bytesProcessed, 8));
		
		outstream.println();
		outstream.println("Lines Out:         \t"+linesOut);
		outstream.println("Bytes Out:         \t"+bytesOut);
		
		//Throw an exception of there was an error in a thread
		if(errorState){
			throw new RuntimeException(getClass().getName()+" terminated in an error state; the output may be corrupt.");
		}
	}
	
	/*--------------------------------------------------------------*/
	/*----------------         Inner Methods        ----------------*/
	/*--------------------------------------------------------------*/
	
	void printMismatchVsTotal(BarcodeStats bs, ByteStreamWriter bsw) {
		ByteBuilder bb=new ByteBuilder();
		bb.append("#Name\tTotal\tBadPair\n");
		linesOut++;
//		ArrayList<Barcode> list=new ArrayList<Barcode>(bs.expectedCodeList.size());
		for(Barcode e : bs.expectedCodeList) {
			Barcode bTotal=bs.codeMap.get(e.name);
			if(bTotal!=null) {e.setCount(bTotal.count());}
		}
		Collections.sort(bs.expectedCodeList);
		for(Barcode e : bs.expectedCodeList) {
			Barcode bTotal=bs.codeMap.get(e.name);
			Barcode bBad=bs.badPairMap.get(e.name);
			bb.append(e.name).tab().append((bTotal==null ? 0 : bTotal.count())).tab().append(bBad==null ? 0 : bBad.count()).nl();
			bsw.print(bb);
			bytesOut+=bb.length();
			bb.clear();
		}
	}
	
	void printActualVsExpected(BarcodeStats bs, ByteStreamWriter bsw) {
		ByteBuilder bb=new ByteBuilder();
		bb.append("#Name\tExpectedCount\tActualCount\n");
		linesOut++;
		String dString=(bs.delimiter<1 ? "" : Character.toString((char)bs.delimiter));
		final double badRate=bs.badPairFraction;
		final double validLeft=bs.leftStats.expectedCodes;
		final double validRight=bs.rightStats.expectedCodes;
		
		//For two barcodes, a.count*b.count*badMult will give the expect number of bad pairs
		final double badMult=bs.validArray[0]/(validLeft*validRight);
		
		for(Barcode ebLeft : bs.leftStats.expectedCodeList) {
			final double leftCount;
			{
				Barcode bLeft=bs.leftStats.codeMap.get(ebLeft.name);
				leftCount=(bLeft==null ? 0 : bLeft.count());
			}
			for(Barcode ebRight : bs.rightStats.expectedCodeList) {
				final double rightCount;
				{
					Barcode bRight=bs.rightStats.codeMap.get(ebRight.name);
					rightCount=(bRight==null ? 0 : bRight.count());
				}
				String pair=ebLeft.name+dString+ebRight.name;
				if(!bs.expectedCodeMap.containsKey(pair)) {
					Barcode bPair=bs.codeMap.get(pair);
					final double pairCount=(bPair==null ? 0 : bPair.count());
					final double expectedCount=leftCount*rightCount*badMult;

					bb.append(pair).tab().append(expectedCount,2).tab().append(pairCount,0).nl();
					bsw.print(bb);
					bytesOut+=bb.length();
					linesOut++;
					bb.clear();
				}
			}
		}
	}
	
	private ByteStreamWriter makeBSW(String fname){
		FileFormat ff=FileFormat.testOutput(fname, FileFormat.TXT, null, true, overwrite, append, false);
		return makeBSW(ff);
	}
	
	private static ByteStreamWriter makeBSW(FileFormat ff){
		if(ff==null){return null;}
		ByteStreamWriter bsw=new ByteStreamWriter(ff);
		bsw.start();
		return bsw;
	}
	
	/*--------------------------------------------------------------*/
	/*----------------            Fields            ----------------*/
	/*--------------------------------------------------------------*/

	/** Primary input file path */
	private String in1=null;
	
	private String expectedBarcodeFile=null;
	private int expectedBarcodeCount=-1;

	/** Primary output file path */
	private String outLeft="leftStats.txt";
	private String outRight="rightStats.txt";
	private String outPair="pairStats.txt";
	
	private BarcodeStats bs;
	
	/*--------------------------------------------------------------*/
	
	private long linesProcessed=0;
	private long bytesProcessed=0;
	private long linesOut=0;
	private long bytesOut=0;
	
	private long maxLines=Long.MAX_VALUE;
	
	/*--------------------------------------------------------------*/
	/*----------------         Final Fields         ----------------*/
	/*--------------------------------------------------------------*/
	
	/** Input File */
	private final FileFormat ffin1;
	
	/*--------------------------------------------------------------*/
	/*----------------        Common Fields         ----------------*/
	/*--------------------------------------------------------------*/
	
	/** Print status messages to this output stream */
	private PrintStream outstream=System.err;
	/** Print verbose messages */
	public static boolean verbose=false;
	/** True if an error was encountered */
	public boolean errorState=false;
	/** Overwrite existing output files */
	private boolean overwrite=true;
	/** Append to existing output files */
	private boolean append=false;
	
}