jpayne@68: package consensus;
jpayne@68: 
jpayne@68: import java.io.PrintStream;
jpayne@68: import java.util.ArrayList;
jpayne@68: import java.util.LinkedHashMap;
jpayne@68: import java.util.Map.Entry;
jpayne@68: import java.util.concurrent.atomic.AtomicIntegerArray;
jpayne@68: import java.util.concurrent.atomic.AtomicLongArray;
jpayne@68: 
jpayne@68: import dna.AminoAcid;
jpayne@68: import fileIO.ByteFile;
jpayne@68: import fileIO.FileFormat;
jpayne@68: import fileIO.ReadWrite;
jpayne@68: import shared.Parse;
jpayne@68: import shared.Parser;
jpayne@68: import shared.PreParser;
jpayne@68: import shared.ReadStats;
jpayne@68: import shared.Shared;
jpayne@68: import shared.Timer;
jpayne@68: import shared.Tools;
jpayne@68: import stream.ConcurrentReadInputStream;
jpayne@68: import stream.ConcurrentReadOutputStream;
jpayne@68: import stream.FastaReadInputStream;
jpayne@68: import stream.Read;
jpayne@68: import stream.SamLine;
jpayne@68: import stream.SamReadStreamer;
jpayne@68: import stream.SamStreamer;
jpayne@68: import structures.ByteBuilder;
jpayne@68: import structures.ListNum;
jpayne@68: import template.Accumulator;
jpayne@68: import template.ThreadWaiter;
jpayne@68: import var2.SamFilter;
jpayne@68: 
jpayne@68: /**
jpayne@68:  * Scaffolds contigs based on paired read mapping.
jpayne@68:  * 
jpayne@68:  * @author Brian Bushnell
jpayne@68:  * @date September 11, 2019
jpayne@68:  *
jpayne@68:  */
jpayne@68: public class Lilypad implements Accumulator<Lilypad.ProcessThread> {
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------        Initialization        ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	
jpayne@68: 	/**
jpayne@68: 	 * Code entrance from the command line.
jpayne@68: 	 * @param args Command line arguments
jpayne@68: 	 */
jpayne@68: 	public static void main(String[] args){
jpayne@68: 		//Start a timer immediately upon code entrance.
jpayne@68: 		Timer t=new Timer();
jpayne@68: 		
jpayne@68: 		//Create an instance of this class
jpayne@68: 		Lilypad x=new Lilypad(args);
jpayne@68: 		
jpayne@68: 		//Run the object
jpayne@68: 		x.process(t);
jpayne@68: 		
jpayne@68: 		//Close the print stream if it was redirected
jpayne@68: 		Shared.closeStream(x.outstream);
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/**
jpayne@68: 	 * Constructor.
jpayne@68: 	 * @param args Command line arguments
jpayne@68: 	 */
jpayne@68: 	public Lilypad(String[] args){
jpayne@68: 		
jpayne@68: 		{//Preparse block for help, config files, and outstream
jpayne@68: 			PreParser pp=new PreParser(args, getClass(), false);
jpayne@68: 			args=pp.args;
jpayne@68: 			outstream=pp.outstream;
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		//Set shared static variables prior to parsing
jpayne@68: 		ReadWrite.USE_PIGZ=ReadWrite.USE_UNPIGZ=true;
jpayne@68: 		ReadWrite.MAX_ZIP_THREADS=Shared.threads();
jpayne@68: 		SamLine.RNAME_AS_BYTES=false;
jpayne@68: 		
jpayne@68: 		samFilter.includeUnmapped=false;
jpayne@68: 		samFilter.includeSupplimentary=false;
jpayne@68: //		samFilter.includeDuplicate=false;
jpayne@68: 		samFilter.includeNonPrimary=false;
jpayne@68: 		samFilter.includeQfail=false;
jpayne@68: 		samFilter.minMapq=4;
jpayne@68: 		
jpayne@68: 		{//Parse the arguments
jpayne@68: 			final Parser parser=parse(args);
jpayne@68: 			
jpayne@68: 			Parser.processQuality();
jpayne@68: 			
jpayne@68: 			maxReads=parser.maxReads;
jpayne@68: 			overwrite=ReadStats.overwrite=parser.overwrite;
jpayne@68: 			append=ReadStats.append=parser.append;
jpayne@68: 			
jpayne@68: 			in=parser.in1;
jpayne@68: 			extin=parser.extin;
jpayne@68: 
jpayne@68: 			out=parser.out1;
jpayne@68: 			extout=parser.extout;
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		{
jpayne@68: //			if("auto".equalsIgnoreCase(atomic)){Scaffold.setCA3A(Shared.threads()>8);}
jpayne@68: //			else{Scaffold.setCA3A(Parse.parseBoolean(atomic));}
jpayne@68: 			samFilter.setSamtoolsFilter();
jpayne@68: 			
jpayne@68: 			streamerThreads=Tools.max(1, Tools.min(streamerThreads, Shared.threads()));
jpayne@68: 			assert(streamerThreads>0) : streamerThreads;
jpayne@68: 		}
jpayne@68: 
jpayne@68: 		validateParams();
jpayne@68: 		fixExtensions(); //Add or remove .gz or .bz2 as needed
jpayne@68: 		checkFileExistence(); //Ensure files can be read and written
jpayne@68: 		checkStatics(); //Adjust file-related static fields as needed for this program 
jpayne@68: 		
jpayne@68: 		//Create output FileFormat objects
jpayne@68: 		ffout=FileFormat.testOutput(out, FileFormat.FASTA, extout, true, overwrite, append, ordered);
jpayne@68: 
jpayne@68: 		//Create input FileFormat objects
jpayne@68: 		ffin=FileFormat.testInput(in, FileFormat.SAM, extin, true, true);
jpayne@68: 		ffref=FileFormat.testInput(ref, FileFormat.FASTA, null, true, true);
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------    Initialization Helpers    ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	
jpayne@68: 	/** Parse arguments from the command line */
jpayne@68: 	private Parser parse(String[] args){
jpayne@68: 		
jpayne@68: 		//Create a parser object
jpayne@68: 		Parser parser=new Parser();
jpayne@68: 		
jpayne@68: 		//Set any necessary Parser defaults here
jpayne@68: 		//parser.foo=bar;
jpayne@68: 		
jpayne@68: 		//Parse each argument
jpayne@68: 		for(int i=0; i<args.length; i++){
jpayne@68: 			String arg=args[i];
jpayne@68: 			
jpayne@68: 			//Break arguments into their constituent parts, in the form of "a=b"
jpayne@68: 			String[] split=arg.split("=");
jpayne@68: 			String a=split[0].toLowerCase();
jpayne@68: 			String b=split.length>1 ? split[1] : null;
jpayne@68: 			if(b!=null && b.equalsIgnoreCase("null")){b=null;}
jpayne@68: 			
jpayne@68: 			if(a.equals("verbose")){
jpayne@68: 				verbose=Parse.parseBoolean(b);
jpayne@68: 			}else if(a.equals("ref") || a.equals("scaffolds")){
jpayne@68: 				ref=b;
jpayne@68: 			}else if(a.equals("insertlist")){
jpayne@68: 				insertList=b;
jpayne@68: 			}else if(a.equals("ordered")){
jpayne@68: 				ordered=Parse.parseBoolean(b);
jpayne@68: 			}else if(a.equalsIgnoreCase("sameStrandPairs")){
jpayne@68: 				sameStrandPairs=Parse.parseBoolean(b);
jpayne@68: 			}else if(a.equalsIgnoreCase("ns") || a.equalsIgnoreCase("n") || a.equalsIgnoreCase("scaffoldbreak") || a.equalsIgnoreCase("gap") || a.equalsIgnoreCase("mingap")){
jpayne@68: 				scaffoldBreakNs=Integer.parseInt(b);
jpayne@68: 				assert(scaffoldBreakNs>0);
jpayne@68: 			}else if(a.equalsIgnoreCase("mindepth")){
jpayne@68: 				minDepth=Integer.parseInt(b);
jpayne@68: 				assert(minDepth>0);
jpayne@68: 			}else if(a.equalsIgnoreCase("maxinsert")){
jpayne@68: 				maxPairDist=Parse.parseIntKMG(b);
jpayne@68: 			}else if(a.equalsIgnoreCase("minWeightRatio") || a.equalsIgnoreCase("minwr")){
jpayne@68: 				minWeightRatio=Float.parseFloat(b);
jpayne@68: 			}else if(a.equalsIgnoreCase("minStrandRatio") || a.equalsIgnoreCase("minsr")){
jpayne@68: 				minStrandRatio=Float.parseFloat(b);
jpayne@68: 			}else if(a.equals("clearfilters") || a.equals("clearfilter")){
jpayne@68: 				if(Parse.parseBoolean(b)){
jpayne@68: 					samFilter.clear();
jpayne@68: 				}
jpayne@68: 			}else if(a.equals("parse_flag_goes_here")){
jpayne@68: 				long fake_variable=Parse.parseKMG(b);
jpayne@68: 				//Set a variable here
jpayne@68: 			}else if(samFilter.parse(arg, a, b)){
jpayne@68: 				//do nothing
jpayne@68: 			}else if(parser.parse(arg, a, b)){//Parse standard flags in the parser
jpayne@68: 				//do nothing
jpayne@68: 			}else{
jpayne@68: 				outstream.println("Unknown parameter "+args[i]);
jpayne@68: 				assert(false) : "Unknown parameter "+args[i];
jpayne@68: 			}
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		return parser;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/** Add or remove .gz or .bz2 as needed */
jpayne@68: 	private void fixExtensions(){
jpayne@68: 		in=Tools.fixExtension(in);
jpayne@68: 		ref=Tools.fixExtension(ref);
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/** Ensure files can be read and written */
jpayne@68: 	private void checkFileExistence(){
jpayne@68: 
jpayne@68: 		//Ensure there is an input file
jpayne@68: 		if(in==null){throw new RuntimeException("Error - an input file is required.");}
jpayne@68: 
jpayne@68: 		//Ensure there is an input file
jpayne@68: 		if(ref==null){throw new RuntimeException("Error - a reference file is required.");}
jpayne@68: 		
jpayne@68: 		//Ensure output files can be written
jpayne@68: 		if(!Tools.testOutputFiles(overwrite, append, false, out)){
jpayne@68: 			outstream.println((out==null)+", "+out);
jpayne@68: 			throw new RuntimeException("\n\noverwrite="+overwrite+"; Can't write to output file "+out+"\n");
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		//Ensure input files can be read
jpayne@68: 		if(!Tools.testInputFiles(false, true, in, ref)){
jpayne@68: 			throw new RuntimeException("\nCan't read some input files.\n");  
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		//Ensure that no file was specified multiple times
jpayne@68: 		if(!Tools.testForDuplicateFiles(true, in, ref, out)){
jpayne@68: 			throw new RuntimeException("\nSome file names were specified multiple times.\n");
jpayne@68: 		}
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/** Adjust file-related static fields as needed for this program */
jpayne@68: 	private static void checkStatics(){
jpayne@68: 		//Adjust the number of threads for input file reading
jpayne@68: 		if(!ByteFile.FORCE_MODE_BF1 && !ByteFile.FORCE_MODE_BF2 && Shared.threads()>2){
jpayne@68: 			ByteFile.FORCE_MODE_BF2=true;
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		assert(FastaReadInputStream.settingsOK());
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/** Ensure parameter ranges are within bounds and required parameters are set */
jpayne@68: 	private boolean validateParams(){
jpayne@68: //		assert(minfoo>0 && minfoo<=maxfoo) : minfoo+", "+maxfoo;
jpayne@68: 		return true;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------         Outer Methods        ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 
jpayne@68: 	/** Create read streams and process all data */
jpayne@68: 	void process(Timer t){
jpayne@68: 		
jpayne@68: 		//Turn off read validation in the input threads to increase speed
jpayne@68: 		final boolean vic=Read.VALIDATE_IN_CONSTRUCTOR;
jpayne@68: 		Read.VALIDATE_IN_CONSTRUCTOR=Shared.threads()<4;
jpayne@68: 		
jpayne@68: 		//Create a read input stream
jpayne@68: 		final SamStreamer ss=makeStreamer(ffin);
jpayne@68: 		
jpayne@68: 		//Load reference
jpayne@68: 		loadReferenceCustom();
jpayne@68: 		
jpayne@68: 		//Reset counters
jpayne@68: 		readsProcessed=readsOut=0;
jpayne@68: 		basesProcessed=basesOut=0;
jpayne@68: 		
jpayne@68: 		//Process the reads in separate threads
jpayne@68: 		spawnThreads(ss);
jpayne@68: 
jpayne@68: 		//Optionally create a read output stream
jpayne@68: 		final ConcurrentReadOutputStream ros=makeCros();
jpayne@68: 		
jpayne@68: 		if(verbose){outstream.println("Fixing reference.");}
jpayne@68: 		
jpayne@68: 		makeScaffolds(ros);
jpayne@68: 		
jpayne@68: 		if(verbose){outstream.println("Finished; closing streams.");}
jpayne@68: 		
jpayne@68: 		//Write anything that was accumulated by ReadStats
jpayne@68: 		errorState|=ReadStats.writeAll();
jpayne@68: 		//Close the read streams
jpayne@68: 		errorState|=ReadWrite.closeStream(ros);
jpayne@68: 		
jpayne@68: 		//Reset read validation
jpayne@68: 		Read.VALIDATE_IN_CONSTRUCTOR=vic;
jpayne@68: 		
jpayne@68: 		//Report timing and results
jpayne@68: 		t.stop();
jpayne@68: 		outstream.println(Tools.timeReadsBasesProcessed(t, readsProcessed, basesProcessed, 8));
jpayne@68: 		outstream.println(Tools.readsBasesOut(readsProcessed, basesProcessed, scaffoldsOut, scaffoldLengthOut, 8, false));
jpayne@68: 		
jpayne@68: 		outstream.println();
jpayne@68: 		outstream.println(Tools.number("Average Insert", totalAverageInsert, 2, 8));
jpayne@68: 		outstream.println(Tools.number("Joins Made    ", gapsAdded, 8));
jpayne@68: 		outstream.println(Tools.number("Ns Added      ", nsAdded, 8));
jpayne@68: 		outstream.println(Tools.number("Contigs In    ", refMap.size(), 8));
jpayne@68: 		outstream.println(Tools.number("Scaffolds Out ", scaffoldsOut, 8));
jpayne@68: 		
jpayne@68: 		
jpayne@68: 		//Throw an exception of there was an error in a thread
jpayne@68: 		if(errorState){
jpayne@68: 			throw new RuntimeException(getClass().getName()+" terminated in an error state; the output may be corrupt.");
jpayne@68: 		}
jpayne@68: 	}
jpayne@68: 
jpayne@68: 	private synchronized void loadReferenceCustom(){
jpayne@68: 		assert(!loadedRef);
jpayne@68: 		ConcurrentReadInputStream cris=makeRefCris();
jpayne@68: 		for(ListNum<Read> ln=cris.nextList(); ln!=null && ln.size()>0; ln=cris.nextList()) {
jpayne@68: 			for(Read r : ln){
jpayne@68: 				String name=r.id;
jpayne@68: 				String name2=Tools.trimToWhitespace(r.id);
jpayne@68: 				Contig cont=new Contig(name, r.bases, r.numericID);
jpayne@68: 				refMap.put(name, cont);
jpayne@68: 				refMap2.put(name2, cont);
jpayne@68: 			}
jpayne@68: 			cris.returnList(ln);
jpayne@68: 		}
jpayne@68: 		ReadWrite.closeStream(cris);
jpayne@68: 		loadedRef=true;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	private ConcurrentReadInputStream makeRefCris(){
jpayne@68: 		ConcurrentReadInputStream cris=ConcurrentReadInputStream.getReadInputStream(maxReads, true, ffref, null);
jpayne@68: 		cris.start(); //Start the stream
jpayne@68: 		if(verbose){outstream.println("Started cris");}
jpayne@68: 		boolean paired=cris.paired();
jpayne@68: 		assert(!paired) : "References should not be paired.";
jpayne@68: 		return cris;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	private SamStreamer makeStreamer(FileFormat ff){
jpayne@68: 		if(ff==null){return null;}
jpayne@68: 		SamStreamer ss=new SamReadStreamer(ff, streamerThreads, true, maxReads);
jpayne@68: 		ss.start(); //Start the stream
jpayne@68: 		if(verbose){outstream.println("Started Streamer");}
jpayne@68: 		return ss;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	private ConcurrentReadOutputStream makeCros(){
jpayne@68: 		if(ffout==null){return null;}
jpayne@68: 
jpayne@68: 		//Select output buffer size based on whether it needs to be ordered
jpayne@68: 		final int buff=(ordered ? Tools.mid(16, 128, (Shared.threads()*2)/3) : 8);
jpayne@68: 
jpayne@68: 		final ConcurrentReadOutputStream ros=ConcurrentReadOutputStream.getStream(ffout, null, buff, null, false);
jpayne@68: 		ros.start(); //Start the stream
jpayne@68: 		return ros;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------       Thread Management      ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	
jpayne@68: 	/** Spawn process threads */
jpayne@68: 	private void spawnThreads(final SamStreamer ss){
jpayne@68: 		
jpayne@68: 		//Do anything necessary prior to processing
jpayne@68: 		
jpayne@68: 		//Determine how many threads may be used
jpayne@68: 		final int threads=Shared.threads();
jpayne@68: 		
jpayne@68: 		//Fill a list with ProcessThreads
jpayne@68: 		ArrayList<ProcessThread> alpt=new ArrayList<ProcessThread>(threads);
jpayne@68: 		for(int i=0; i<threads; i++){
jpayne@68: 			alpt.add(new ProcessThread(ss, i));
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		//Start the threads
jpayne@68: 		for(ProcessThread pt : alpt){
jpayne@68: 			pt.start();
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		//Wait for threads to finish
jpayne@68: 		boolean success=ThreadWaiter.waitForThreads(alpt, this);
jpayne@68: 		errorState&=!success;
jpayne@68: 		
jpayne@68: 		//Do anything necessary after processing
jpayne@68: 		totalAverageInsert=totalInsertSum/(double)totalInsertCount;
jpayne@68: 		insertByPercentile=Tools.makeHistogram(insertCounts, buckets);
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	@Override
jpayne@68: 	public final void accumulate(ProcessThread pt){
jpayne@68: 		readsProcessed+=pt.readsProcessedT;
jpayne@68: 		basesProcessed+=pt.basesProcessedT;
jpayne@68: 		readsOut+=pt.readsOutT;
jpayne@68: 		basesOut+=pt.basesOutT;
jpayne@68: 		
jpayne@68: 		totalInsertSum+=pt.totalInsertSumT;
jpayne@68: 		totalInsertCount+=pt.totalInsertCountT;
jpayne@68: 		
jpayne@68: 		errorState|=(!pt.success);
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	@Override
jpayne@68: 	public final boolean success(){return !errorState;}
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------         Inner Methods        ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	
jpayne@68: 	private void makeScaffolds(ConcurrentReadOutputStream ros){
jpayne@68: 		ByteBuilder bb=new ByteBuilder(1000000);
jpayne@68: 
jpayne@68: 		ArrayList<Read> list=new ArrayList<Read>(200);
jpayne@68: 		long num=0;
jpayne@68: 		long lengthSum=0;
jpayne@68: 		for(Entry<String, Contig> e : refMap.entrySet()){
jpayne@68: 			Contig cont=e.getValue();
jpayne@68: 			if(!cont.processed()){
jpayne@68: 				Read r=cont.makeScaffold(bb);
jpayne@68: 				assert(r!=null);
jpayne@68: 
jpayne@68: 				lengthSum+=r.length();
jpayne@68: 				list.add(r);
jpayne@68: 				scaffoldsOut++;
jpayne@68: 				scaffoldLengthOut+=r.length();
jpayne@68: 
jpayne@68: 				if(list.size()>=200 || lengthSum>=100000){
jpayne@68: 					if(ros!=null){ros.add(list, num);}
jpayne@68: 					list=new ArrayList<Read>(200);
jpayne@68: 					num++;
jpayne@68: 					lengthSum=0;
jpayne@68: 				}
jpayne@68: 				assert(cont.processed());
jpayne@68: 			}
jpayne@68: 		}
jpayne@68: 		if(list.size()>0){
jpayne@68: 			if(ros!=null){ros.add(list, num);}
jpayne@68: 		}
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	private static int calcInsertSize(SamLine sl) {
jpayne@68: 		assert(sl.mapped() && sl.pairedOnSameChrom());
jpayne@68: 		assert(sl.primary());
jpayne@68: 		assert(!sl.supplementary());
jpayne@68: 		assert(sl.leftmost());
jpayne@68: 		
jpayne@68: 		assert(sl.tlen>0) : sl.tlen+"\n\n"+sl;
jpayne@68: 		return sl.tlen>0 ? sl.tlen : -sl.tlen;
jpayne@68: 		
jpayne@68: //		final int insertSize;
jpayne@68: //		String insertTag=null;
jpayne@68: //		if(sl.optional!=null){
jpayne@68: //			for(String s : sl.optional){
jpayne@68: //				if(s.startsWith("X8:Z:")){
jpayne@68: //					insertTag=s;
jpayne@68: //					break;
jpayne@68: //				}
jpayne@68: //			}
jpayne@68: //		}
jpayne@68: //		if(insertTag!=null){
jpayne@68: //			insertSize=Integer.parseInt(insertTag.substring(5));
jpayne@68: //		}else{
jpayne@68: //			insertSize=sl.tlen;//This is unsafe due to indels.
jpayne@68: //			assert(false) : "Reads need insert size tags.";
jpayne@68: //		}
jpayne@68: //		assert(insertSize>0) : sl;
jpayne@68: //		
jpayne@68: //		return insertSize;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	private Contig getScaffold(String rname){
jpayne@68: 		Contig scaf=refMap.get(rname);
jpayne@68: 		if(scaf==null){scaf=refMap2.get(Tools.trimToWhitespace(rname));}
jpayne@68: 		assert(scaf!=null) : "Can't find graph for "+rname;
jpayne@68: 		return scaf;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------         Inner Classes        ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	
jpayne@68: 	/** This class is static to prevent accidental writing to shared variables.
jpayne@68: 	 * It is safe to remove the static modifier. */
jpayne@68: 	class ProcessThread extends Thread {
jpayne@68: 		
jpayne@68: 		//Constructor
jpayne@68: 		ProcessThread(final SamStreamer ss_, final int tid_){
jpayne@68: 			ss=ss_;
jpayne@68: 			tid=tid_;
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		//Called by start()
jpayne@68: 		@Override
jpayne@68: 		public void run(){
jpayne@68: 			//Do anything necessary prior to processing
jpayne@68: 			
jpayne@68: 			//Process the reads
jpayne@68: 			processInner();
jpayne@68: 			
jpayne@68: 			//Do anything necessary after processing
jpayne@68: 			
jpayne@68: 			//Indicate successful exit status
jpayne@68: 			success=true;
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		/** Iterate through the reads */
jpayne@68: 		void processInner(){
jpayne@68: 			
jpayne@68: 			//Grab and process all lists
jpayne@68: 			for(ListNum<Read> ln=ss.nextReads(); ln!=null; ln=ss.nextReads()){
jpayne@68: //				if(verbose){outstream.println("Got list of size "+list.size());} //Disabled due to non-static access
jpayne@68: 				
jpayne@68: 				processList(ln);
jpayne@68: 			}
jpayne@68: 			
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		void processList(ListNum<Read> ln){
jpayne@68: 
jpayne@68: 			//Grab the actual read list from the ListNum
jpayne@68: 			final ArrayList<Read> reads=ln.list;
jpayne@68: 			
jpayne@68: 			//Loop through each read in the list
jpayne@68: 			for(int idx=0; idx<reads.size(); idx++){
jpayne@68: 				final Read r=reads.get(idx);
jpayne@68: 				
jpayne@68: 				//Validate reads in worker threads
jpayne@68: 				if(!r.validated()){r.validate(true);}
jpayne@68: 
jpayne@68: 				//Track the initial length for statistics
jpayne@68: 				final int initialLength=r.length();
jpayne@68: 
jpayne@68: 				//Increment counters
jpayne@68: 				readsProcessedT+=r.pairCount();
jpayne@68: 				basesProcessedT+=initialLength;
jpayne@68: 				
jpayne@68: 				processRead(r);
jpayne@68: 			}
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		/**
jpayne@68: 		 * Process a read or a read pair.
jpayne@68: 		 * @param r Read 1
jpayne@68: 		 * @param r2 Read 2 (may be null)
jpayne@68: 		 * @return True if the reads should be kept, false if they should be discarded.
jpayne@68: 		 */
jpayne@68: 		void processRead(final Read r){
jpayne@68: 			final SamLine sl=r.samline;
jpayne@68: 			assert(sl!=null) : sl;
jpayne@68: 			if(samFilter!=null && !samFilter.passesFilter(sl)){return;}
jpayne@68: 			
jpayne@68: 			//sl.nextMapped();
jpayne@68: 			if(sl.mapped() && sl.primary() && !sl.supplementary()){
jpayne@68: 				final String rname=sl.rnameS();
jpayne@68: 				Contig scaf=getScaffold(rname);
jpayne@68: 				if(scaf!=null){
jpayne@68: 					if(sl.pairedOnSameChrom() && sl.properPair() && sl.leftmost()){
jpayne@68: 						final int insertSize=calcInsertSize(sl);
jpayne@68: 						insertCounts.incrementAndGet(Tools.mid(0, insertSize, insertCounts.length()-1));
jpayne@68: 						totalInsertSumT+=insertSize;
jpayne@68: 						totalInsertCountT++;
jpayne@68: 					}
jpayne@68: 					scaf.add(sl);
jpayne@68: 
jpayne@68: 					readsOutT++;
jpayne@68: 					basesOutT+=r.length();
jpayne@68: 				}
jpayne@68: 			}
jpayne@68: 			if(sl.mapped() && sl.pairedOnSameChrom() && sl.properPair() && sl.primary() && !sl.supplementary() && sl.leftmost()){
jpayne@68: 				final String rname=sl.rnameS();
jpayne@68: 				
jpayne@68: 				Contig scaf=getScaffold(rname);
jpayne@68: 				if(scaf!=null){
jpayne@68: 					final int insertSize=calcInsertSize(sl);
jpayne@68: 					insertCounts.incrementAndGet(Tools.mid(0, insertSize, insertCounts.length()-1));
jpayne@68: 					scaf.add(sl);
jpayne@68: 
jpayne@68: 					readsOutT++;
jpayne@68: 					basesOutT+=r.length();
jpayne@68: 
jpayne@68: 					totalInsertSumT+=insertSize;
jpayne@68: 					totalInsertCountT++;
jpayne@68: 				}
jpayne@68: 			}
jpayne@68: 		}
jpayne@68: 
jpayne@68: 		/** Number of reads processed by this thread */
jpayne@68: 		protected long readsProcessedT=0;
jpayne@68: 		/** Number of bases processed by this thread */
jpayne@68: 		protected long basesProcessedT=0;
jpayne@68: 		
jpayne@68: 		/** Number of reads retained by this thread */
jpayne@68: 		protected long readsOutT=0;
jpayne@68: 		/** Number of bases retained by this thread */
jpayne@68: 		protected long basesOutT=0;
jpayne@68: 		
jpayne@68: 		protected long totalInsertSumT=0;
jpayne@68: 		protected long totalInsertCountT=0;
jpayne@68: 		
jpayne@68: 		long insertSum=0;
jpayne@68: 		
jpayne@68: 		/** True only if this thread has completed successfully */
jpayne@68: 		boolean success=false;
jpayne@68: 		
jpayne@68: 		/** Shared input stream */
jpayne@68: 		private final SamStreamer ss;
jpayne@68: 		/** Thread ID */
jpayne@68: 		final int tid;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	Contig findLeftmost(Contig source){
jpayne@68: 		if(verbose){System.err.println("findLeftmost("+source.name+")");}
jpayne@68: 		while(true) {
jpayne@68: 			assert(!source.processed());
jpayne@68: 			if(source.processed()){return null;}
jpayne@68: 			source.processedLeft=true;
jpayne@68: 			Edge se=source.bestEdge(true);
jpayne@68: 			if(verbose){System.err.println("Found source edge "+se);}
jpayne@68: 			if(se==null){return source;}
jpayne@68: 			Contig dest=se.dest;
jpayne@68: 			if(dest.processed()){
jpayne@68: 				if(verbose){System.err.println("Dest was processed; returning.");}
jpayne@68: 				return source;
jpayne@68: 			}
jpayne@68: 			if(se.sameStrand()){
jpayne@68: 				if(source.strand==dest.strand){
jpayne@68: 
jpayne@68: 				}else{
jpayne@68: 					if(verbose){System.err.println("Flipping "+dest.name);}
jpayne@68: 					dest.flip();
jpayne@68: 				}
jpayne@68: 			}else{
jpayne@68: 				if(source.strand==dest.strand){
jpayne@68: 					if(verbose){System.err.println("Flipping "+dest.name);}
jpayne@68: 					dest.flip();
jpayne@68: 				}else{
jpayne@68: 
jpayne@68: 				}
jpayne@68: 			}
jpayne@68: 			Edge de=dest.bestEdge(false);
jpayne@68: 			if(verbose){System.err.println("Found dest edge "+de);}
jpayne@68: 			if(de==null || de.dest!=source){
jpayne@68: 				if(dest.strand==1){dest.flip();}
jpayne@68: 				if(verbose){System.err.println("Dest edge did not match; returning.");}
jpayne@68: 				return source;
jpayne@68: 			}
jpayne@68: 			source=dest;
jpayne@68: 			if(verbose){System.err.println("Migrated to next node.");}
jpayne@68: 		}
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	Read expandRight(final Contig source0, ByteBuilder bb){
jpayne@68: 		if(verbose){System.err.println("expandRight("+source0.name+")");}
jpayne@68: 		bb.clear();
jpayne@68: 		Contig source=source0;
jpayne@68: 		while(true) {
jpayne@68: 			assert(!source.processedRight);
jpayne@68: 			if(source.processedRight){return null;}
jpayne@68: 			if(source.strand==1){
jpayne@68: 				Tools.reverseInPlace(source.depthArray);
jpayne@68: 			}
jpayne@68: 			source.processedRight=true;
jpayne@68: 			bb.append(source.bases);
jpayne@68: 			Edge se=source.bestEdge(false);
jpayne@68: 			if(verbose){System.err.println("Found source edge "+se);}
jpayne@68: 			if(se==null){break;}
jpayne@68: 			Contig dest=se.dest;
jpayne@68: 			if(dest.processedRight){
jpayne@68: 				if(verbose){System.err.println("Dest was processed; returning.");}
jpayne@68: 				break;
jpayne@68: 			}
jpayne@68: 			if(se.sameStrand()){
jpayne@68: 				if(source.strand==dest.strand){
jpayne@68: 
jpayne@68: 				}else{
jpayne@68: 					if(verbose){System.err.println("Flipping "+dest.name);}
jpayne@68: 					dest.flip();
jpayne@68: 				}
jpayne@68: 			}else{
jpayne@68: 				if(source.strand==dest.strand){
jpayne@68: 					if(verbose){System.err.println("Flipping "+dest.name);}
jpayne@68: 					dest.flip();
jpayne@68: 				}else{
jpayne@68: 
jpayne@68: 				}
jpayne@68: 			}
jpayne@68: 			Edge de=dest.bestEdge(true);
jpayne@68: 			if(verbose){System.err.println("Found dest edge "+de);}
jpayne@68: 			if(de==null || de.dest!=source){
jpayne@68: 				if(verbose){System.err.println("Dest edge did not match; returning.");}
jpayne@68: 				if(dest.strand==1){dest.flip();}
jpayne@68: 				break;
jpayne@68: 			}
jpayne@68: 			
jpayne@68: 			//Now append Ns
jpayne@68: 			int observedLength=(int)(se.distanceSum/se.count());
jpayne@68: 			long depth=se.count();
jpayne@68: 			int depthProxyIndex=(source.length()-Tools.min(source.length()/2, 300));
jpayne@68: 			long depthProxy=source.depthArray.get(depthProxyIndex);
jpayne@68: 			int percentile=(int)(buckets*depth/(float)(depth+depthProxy));
jpayne@68: 			int inferredLength=insertByPercentile[percentile];
jpayne@68: 			
jpayne@68: 			int Ns=(Tools.max(scaffoldBreakNs, inferredLength-observedLength));
jpayne@68: 			for(int i=0; i<Ns; i++){bb.append('N');}
jpayne@68: 			source=dest;
jpayne@68: 			
jpayne@68: 			gapsAdded++;
jpayne@68: 			nsAdded+=Ns;
jpayne@68: 		}
jpayne@68: 		Read r=new Read(bb.toBytes(), null, source0.name, source0.numericID);
jpayne@68: 		return r;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	
jpayne@68: 	private class Contig {
jpayne@68: 		
jpayne@68: 		Contig(String name_, byte[] bases_, long numericID_){
jpayne@68: 			name=name_;
jpayne@68: 			bases=bases_;
jpayne@68: 			numericID=(int)numericID_;
jpayne@68: 			depthArray=new AtomicIntegerArray(bases.length);
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		public Read makeScaffold(ByteBuilder bb) {
jpayne@68: 			assert(!processed());
jpayne@68: 			Contig leftmost=findLeftmost(this);
jpayne@68: 			return expandRight(leftmost, bb);
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		Edge bestEdge(boolean left) {
jpayne@68: 			final LinkedHashMap<String, Edge> map=(left ? leftEdgeMap : rightEdgeMap);
jpayne@68: 			if(map.isEmpty()){return null;}
jpayne@68: 			long weightSum=0;
jpayne@68: 			long countSum=0;
jpayne@68: 			Edge best=null;
jpayne@68: 			for(Entry<String, Edge> entry : map.entrySet()){
jpayne@68: 				Edge e=entry.getValue();
jpayne@68: 				weightSum+=e.weight;
jpayne@68: 				countSum+=e.count();
jpayne@68: 				if(best==null || e.weight>best.weight){best=e;}
jpayne@68: 			}
jpayne@68: 			if(best.count()<minDepth){return null;}
jpayne@68: 			if(weightSum*minWeightRatio>best.weight){return null;}
jpayne@68: 			if(best.strandRatio()<minStrandRatio){return null;}
jpayne@68: 			if(best.badCount>0.5*best.count()){return null;}
jpayne@68: 			return best;
jpayne@68: 		}
jpayne@68: 
jpayne@68: 		void add(SamLine sl){
jpayne@68: 			assert(sl.mapped() && sl.primary() && !sl.supplementary());
jpayne@68: 			if(sl.nextMapped()){
jpayne@68: 				if(sl.pairedOnSameChrom()){
jpayne@68: 					if(!sl.properPair()){
jpayne@68: 						addCoverageSingleton(sl);
jpayne@68: 					}else if(sl.leftmost()){
jpayne@68: 						addCoveragePaired(sl);
jpayne@68: 					}
jpayne@68: 				}else{
jpayne@68: 					addCoverageSingleton(sl);
jpayne@68: 					handleMixedPair(sl);
jpayne@68: 				}
jpayne@68: 			}else{
jpayne@68: 				addCoverageSingleton(sl);
jpayne@68: 			}
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		private void addCoverageSingleton(SamLine sl){
jpayne@68: 			assert(sl.cigar!=null);
jpayne@68: 			int start=sl.pos-1;
jpayne@68: 			int stop=start+SamLine.calcCigarLength(sl.cigar, false, false);
jpayne@68: 			
jpayne@68: 			for(int i=start; i<stop; i++){
jpayne@68: 				if(i>=0 && i<bases.length){
jpayne@68: 					depthArray.incrementAndGet(i);
jpayne@68: 				}
jpayne@68: 			}
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		private void addCoveragePaired(SamLine sl){
jpayne@68: 			assert(sl.cigar!=null);
jpayne@68: 			assert(sl.leftmost() && sl.pairedOnSameChrom() && sl.nextMapped());
jpayne@68: 			int start=sl.pos-1;
jpayne@68: 			int stop=start+sl.tlen;
jpayne@68: 			
jpayne@68: 			for(int i=start; i<stop; i++){
jpayne@68: 				if(i>=0 && i<bases.length){
jpayne@68: 					depthArray.incrementAndGet(i);
jpayne@68: 				}
jpayne@68: 			}
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		/** Reads mapping to different contigs */
jpayne@68: 		private void handleMixedPair(SamLine sl){
jpayne@68: 			assert(sl.mapped() && sl.nextMapped() && !sl.pairedOnSameChrom());
jpayne@68: 			String rname=sl.rnameS();
jpayne@68: 			String rnext=sl.rnextS();
jpayne@68: 			if(rname.equals(rnext)){return;}
jpayne@68: 			
jpayne@68: 			final boolean left=(sl.strand()==1);
jpayne@68: 			LinkedHashMap<String, Edge> map=(left ? leftEdgeMap : rightEdgeMap);
jpayne@68: 			Edge e=map.get(rnext);
jpayne@68: 			Contig dest=null;
jpayne@68: 			if(e==null){
jpayne@68: 				dest=getScaffold(rnext);
jpayne@68: 				if(dest==null){return;}
jpayne@68: 				e=new Edge(this, dest, left);
jpayne@68: 				map.put(rnext, e);
jpayne@68: 			}
jpayne@68: 			e.add(sl);
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		void flip(){//Be careful with this
jpayne@68: 			AminoAcid.reverseComplementBasesInPlace(bases);
jpayne@68: 			strand^=1;
jpayne@68: 			LinkedHashMap<String, Edge> temp=leftEdgeMap;
jpayne@68: 			leftEdgeMap=rightEdgeMap;
jpayne@68: 			rightEdgeMap=temp;
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		int length(){return bases.length;}
jpayne@68: 		
jpayne@68: 		final int numericID;
jpayne@68: 		final String name;
jpayne@68: 		final byte[] bases;
jpayne@68: 		final AtomicIntegerArray depthArray;
jpayne@68: 		int strand=0;
jpayne@68: 
jpayne@68: 		boolean processedLeft=false;
jpayne@68: 		boolean processedRight=false;
jpayne@68: 		boolean processed(){return processedLeft || processedRight;}
jpayne@68: 
jpayne@68: 		LinkedHashMap<String, Edge> leftEdgeMap=new LinkedHashMap<String, Edge>();
jpayne@68: 		LinkedHashMap<String, Edge> rightEdgeMap=new LinkedHashMap<String, Edge>();
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	private class Edge{
jpayne@68: 		
jpayne@68: 		Edge(Contig source_, Contig dest_, boolean left_){
jpayne@68: 			source=source_;
jpayne@68: 			dest=dest_;
jpayne@68: 			leftEdge=left_;
jpayne@68: 		}
jpayne@68: 
jpayne@68: 		void add(SamLine sl){
jpayne@68: 			final boolean sameStrandReads=(sl.strand()==sl.mateStrand());
jpayne@68: 			final boolean sameStrandContigs=(sameStrandPairs==sameStrandReads);
jpayne@68: 			final int spos, dpos;
jpayne@68: 			if(leftEdge){
jpayne@68: 				spos=sl.pos+sl.calcCigarLength(true, false)-1;
jpayne@68: 				dpos=(sameStrandContigs ? dest.length()-sl.pnext : sl.pnext+sl.length())-1;
jpayne@68: 			}else{
jpayne@68: 				spos=source.length()-sl.pos-1;
jpayne@68: 				dpos=(sameStrandContigs ? sl.pnext+sl.length() : dest.length()-sl.pnext)-1;
jpayne@68: 			}
jpayne@68: 			final int distance=spos+dpos;
jpayne@68: 			
jpayne@68: 			if(distance>maxPairDist){
jpayne@68: 
jpayne@68: //				assert(false) : "distance="+distance+", spos="+spos+", dpos="+dpos+", sameStrandContigs="+sameStrandContigs+
jpayne@68: //					"\nsl.pos="+sl.pos+", sl.pnext="+sl.pnext+", strand="+sl.strand()+", nextStrand="+sl.mateStrand()+", left="+leftEdge
jpayne@68: //					+"\n"+sl;
jpayne@68: //				badCount++;
jpayne@68: 				return;
jpayne@68: 			}
jpayne@68: 			
jpayne@68: 			distanceSum+=distance;
jpayne@68: 			
jpayne@68: 			weight+=sl.mapq;
jpayne@68: 			if(sameStrandContigs){
jpayne@68: 				sameStrandCount++;
jpayne@68: 			}else{
jpayne@68: 				difStrandCount++;
jpayne@68: 			}
jpayne@68: //			assert(false) : weight;
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		public float strandRatio() {
jpayne@68: 			return Tools.max(sameStrandCount, difStrandCount)/(float)(sameStrandCount+difStrandCount);
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		public boolean sameStrand(){
jpayne@68: 			return sameStrandCount>=difStrandCount;
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		@Override
jpayne@68: 		public String toString(){
jpayne@68: 			return "("+source.name+"->"+dest.name+", "+(leftEdge ? "left" : "right")+", weight="+weight+
jpayne@68: 					", same="+sameStrandCount+", dif="+difStrandCount+", bad="+badCount+")";
jpayne@68: 		}
jpayne@68: 		
jpayne@68: 		long count(){return sameStrandCount+difStrandCount;}
jpayne@68: 		
jpayne@68: 		final Contig source;
jpayne@68: 		final Contig dest;
jpayne@68: 		long sameStrandCount;
jpayne@68: 		long difStrandCount;
jpayne@68: 		long distanceSum;
jpayne@68: 		long weight;
jpayne@68: 		long badCount;
jpayne@68: 		final boolean leftEdge;
jpayne@68: 	}
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------            Fields            ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 
jpayne@68: 	/** Primary input file path */
jpayne@68: 	private String in=null;
jpayne@68: 	/** Secondary input file path */
jpayne@68: 	private String ref=null;
jpayne@68: 
jpayne@68: 	/** Primary output file path */
jpayne@68: 	private String out=null;
jpayne@68: 	
jpayne@68: 	/** Override input file extension */
jpayne@68: 	private String extin=null;
jpayne@68: 	/** Override output file extension */
jpayne@68: 	private String extout=null;
jpayne@68: 	
jpayne@68: 	private String insertList=null;
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 
jpayne@68: 	/** Number of reads processed */
jpayne@68: 	protected long readsProcessed=0;
jpayne@68: 	/** Number of bases processed */
jpayne@68: 	protected long basesProcessed=0;
jpayne@68: 
jpayne@68: 	/** Number of reads retained */
jpayne@68: 	protected long readsOut=0;
jpayne@68: 	/** Number of bases retained */
jpayne@68: 	protected long basesOut=0;
jpayne@68: 
jpayne@68: 	protected long scaffoldsOut=0;
jpayne@68: 	protected long scaffoldLengthOut=0;
jpayne@68: 	
jpayne@68: 	protected long totalInsertSum=0;
jpayne@68: 	protected long totalInsertCount=0;
jpayne@68: 	protected double totalAverageInsert;
jpayne@68: 	
jpayne@68: 	/** Quit after processing this many input reads; -1 means no limit */
jpayne@68: 	private long maxReads=-1;
jpayne@68: 	
jpayne@68: 	boolean sameStrandPairs=false;
jpayne@68: 	
jpayne@68: 	int gapsAdded=0;
jpayne@68: 	long nsAdded=0;
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	
jpayne@68: 	/** Threads dedicated to reading the sam file */
jpayne@68: 	private int streamerThreads=SamStreamer.DEFAULT_THREADS;
jpayne@68: 	
jpayne@68: 	private boolean loadedRef=false;
jpayne@68: 	
jpayne@68: 	private int minDepth=4;
jpayne@68: 
jpayne@68: 	private float minWeightRatio=0.8f;
jpayne@68: 	private float minStrandRatio=0.8f;
jpayne@68: 	
jpayne@68: 	private int scaffoldBreakNs=10;
jpayne@68: 	
jpayne@68: 	private int maxPairDist=3000;
jpayne@68: 	
jpayne@68: 	private int buckets=1000;
jpayne@68: 	protected AtomicLongArray insertCounts=new AtomicLongArray(20000);
jpayne@68: 	protected int[] insertByPercentile;
jpayne@68: 	
jpayne@68: 	public final SamFilter samFilter=new SamFilter();
jpayne@68: 	
jpayne@68: 	/** Uses full ref names */
jpayne@68: 	public LinkedHashMap<String, Contig> refMap=new LinkedHashMap<String, Contig>();
jpayne@68: 	/** Uses truncated ref names */
jpayne@68: 	public LinkedHashMap<String, Contig> refMap2=new LinkedHashMap<String, Contig>();
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------         Final Fields         ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 
jpayne@68: 	/** Primary input file */
jpayne@68: 	private final FileFormat ffin;
jpayne@68: 	/** Secondary input file */
jpayne@68: 	private final FileFormat ffref;
jpayne@68: 	
jpayne@68: 	/** Primary output file */
jpayne@68: 	private final FileFormat ffout;
jpayne@68: 	
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	/*----------------        Common Fields         ----------------*/
jpayne@68: 	/*--------------------------------------------------------------*/
jpayne@68: 	
jpayne@68: 	/** Print status messages to this output stream */
jpayne@68: 	private PrintStream outstream=System.err;
jpayne@68: 	/** Print verbose messages */
jpayne@68: 	public static boolean verbose=false;
jpayne@68: 	/** True if an error was encountered */
jpayne@68: 	public boolean errorState=false;
jpayne@68: 	/** Overwrite existing output files */
jpayne@68: 	private boolean overwrite=false;
jpayne@68: 	/** Append to existing output files */
jpayne@68: 	private boolean append=false;
jpayne@68: 	/** Reads are output in input order */
jpayne@68: 	private boolean ordered=false;
jpayne@68: 	
jpayne@68: }