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
|
package barcode;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map.Entry;
import fileIO.ByteFile;
import fileIO.ByteStreamWriter;
import fileIO.FileFormat;
import fileIO.ReadWrite;
import fileIO.TextFile;
import hiseq.IlluminaHeaderParser2;
import shared.LineParser2;
import shared.Tools;
import stream.ConcurrentReadInputStream;
import stream.Read;
import structures.ByteBuilder;
import structures.ListNum;
import structures.SuperLongList;
/**
* Static class for routine barcode-counting functions,
* like file manipulation and actually counting them.
*
* @author Brian Bushnell
* @date April 9, 2024
*
*/
public class BarcodeCounter {
//TODO: Make non-static and put barcode-length/number/delimiter detection here.
/*--------------------------------------------------------------*/
/*---------------- File I/O ----------------*/
/*--------------------------------------------------------------*/
public static final HashMap<String, Barcode> countBarcodes(String readsFile, long maxReads, boolean addTile) {
FileFormat ff=FileFormat.testInput(readsFile, FileFormat.FASTQ, null, true, true);
final byte delimiter=(byte)ff.barcodeDelimiter();
final int barcodesPerRead=ff.barcodesPerRead();
return countBarcodes(ff, maxReads, addTile);
}
public static final HashMap<String, Barcode> countBarcodes(FileFormat ff, long maxReads, boolean addTile) {
final ConcurrentReadInputStream cris=makeCris(ff, maxReads);
HashMap<String, Barcode> map=new HashMap<String, Barcode>();
//Grab the first ListNum of reads
ListNum<Read> ln=cris.nextList();
//Check to ensure pairing is as expected
if(ln!=null && !ln.isEmpty()){
Read r=ln.get(0);
assert(r.samline!=null || (r.mate!=null)==cris.paired());
}
IlluminaHeaderParser2 ihp=new IlluminaHeaderParser2();
//As long as there is a nonempty read list...
while(ln!=null && ln.size()>0){
processList(ln, cris, map, ihp, addTile);
//Fetch a new list
ln=cris.nextList();
}
//Notify the input stream that the final list was used
if(ln!=null){
cris.returnList(ln.id, ln.list==null || ln.list.isEmpty());
}
errorState|=ReadWrite.closeStream(cris);
return map;
}
private static final ConcurrentReadInputStream makeCris(FileFormat ff1, long maxReads){
ConcurrentReadInputStream cris=ConcurrentReadInputStream.getReadInputStream(
maxReads, true, ff1, null);
cris.start(); //Start the stream
return cris;
}
private static final void processList(ListNum<Read> ln, final ConcurrentReadInputStream cris,
HashMap<String, Barcode> codeMap, IlluminaHeaderParser2 ihp, boolean addTile){
//Grab the actual read list from the ListNum
final ArrayList<Read> reads=ln.list;
//Loop through each read in the list
for(int idx=0; idx<reads.size(); idx++){
final Read r1=reads.get(idx);
if(!r1.validated()){r1.validate(true);}
processRead(r1, codeMap, ihp, addTile);
}
//Notify the input stream that the list was used
cris.returnList(ln);
}
private static final void processRead(final Read r1, HashMap<String, Barcode> codeMap, IlluminaHeaderParser2 ihp, boolean addTile){
ihp.parse(r1.id);
final String key=ihp.barcode();
if(key==null){return;}
String key2=key;
int tile=0;
if(addTile) {
tile=ihp.tile();
assert(tile>10 && tile<10000);
key2+=tile;
}
Barcode b=codeMap.get(key2);
if(b==null){
b=new Barcode(key);
b.tile=tile;
codeMap.put(key2, b);
}
b.increment(1);
}
/*--------------------------------------------------------------*/
public static final ArrayList<String> loadBarcodes(String fname, int forceDelimiter){
if(fname==null){return null;}
String[] codes;
if(new File(fname).exists()) {
codes=TextFile.toStringLines(fname);
}else {
codes=fname.split(",");
}
ArrayList<String> expected=new ArrayList<String>();
for(int i=0; i<codes.length; i++){
String s=codes[i];
if(!Tools.startsWith(s, '#')){
// s=removeTab(s);
// assert(s.indexOf('\t')<0) : "Barcodes should not contain a tab: '"+s+"'";//Although it's fine if they do; just use -da
s=BarcodeStats.fixBarcode(s, forceDelimiter, false, false);
expected.add(s);
}
}
return expected;
}
/*--------------------------------------------------------------*/
public static final ArrayList<Barcode> loadCounts(String fname, long minCount){
LineParser2 lp=new LineParser2('\t');
ByteFile bf=ByteFile.makeByteFile(fname, true);
ArrayList<Barcode> list=new ArrayList<Barcode>();
for(byte[] line=bf.nextLine(); line!=null; line=bf.nextLine()) {
if(line[0]=='#') {continue;}
lp.set(line);
String a=lp.parseString();
assert(lp.hasMore()) : new String(line);
long b=lp.parseLong();
if(b>=minCount) {
Barcode c=new Barcode(a, b);
list.add(c);
}
}
errorState=bf.close()|errorState;
return list;
}
public static final boolean writeCounts(Collection<Barcode> counts, long minCount, FileFormat ff,
boolean sort, boolean overwrite, boolean append){
return writeCounts(counts, minCount, ff, sort, ff.overwrite(), ff.append());
}
public static final boolean writeCounts(Collection<Barcode> counts, long minCount, String fname,
boolean sort, boolean overwrite, boolean append){
if(sort) {
ArrayList<Barcode> list=new ArrayList<Barcode>(counts);
Collections.sort(list);
counts=list;
}
ByteStreamWriter bsw=new ByteStreamWriter(fname, overwrite, append, true);
bsw.start();
long sum=0;
for(Barcode bc : counts) {sum+=bc.count();}
bsw.println("#Barcodes\t"+sum);
bsw.println("#Unique\t"+counts.size());
ByteBuilder bb=new ByteBuilder(128);
for(Barcode b : counts) {
if(b.count()>=minCount) {
b.appendTo(bb).nl();
bsw.print(bb);
bb.clear();
}
// if(b.count()>=minCount) {
// bsw.print(b.name).tab().print(b.count()).nl();
// }
}
boolean b=bsw.poisonAndWait();
errorState|=b;
return b;
}
public static final boolean writeCounts(HashMap<String, Barcode> counts, String fname,
boolean overwrite, boolean append){
ByteStreamWriter bsw=new ByteStreamWriter(fname, overwrite, append, true);
bsw.start();
for(Entry<String, Barcode> e : counts.entrySet()) {
Barcode b=e.getValue();
bsw.print(b.name).tab().print(b.count()).nl();
}
boolean b=bsw.poisonAndWait();
errorState|=b;
return b;
}
/*--------------------------------------------------------------*/
public static HashMap<String, String> loadAssignmentMap(String mapIn) {
LineParser2 lp=new LineParser2('\t');
ByteFile bf=ByteFile.makeByteFile(mapIn, true);
HashMap<String, String> map=new HashMap<String, String>();
for(byte[] line=bf.nextLine(); line!=null; line=bf.nextLine()) {
if(line[0]=='#') {continue;}
lp.set(line);
String a=lp.parseString();
assert(lp.hasMore()) : new String(line);
String b=lp.parseString();
map.put(a, b);
}
errorState=bf.close()|errorState;
return map;
}
public static boolean writeAssignmentMap(HashMap<String, String> assignmentMap,
String mapOut, boolean overwrite, boolean append) {
ByteStreamWriter bsw=new ByteStreamWriter(mapOut, overwrite, append, true);
bsw.start();
for(Entry<String, String> e : assignmentMap.entrySet()) {
String a=e.getKey(), b=e.getValue();
bsw.print(a).tab().print(b);
bsw.nl();
}
boolean b=bsw.poisonAndWait();
errorState|=b;
return b;
}
/*--------------------------------------------------------------*/
/*---------------- Statistics ----------------*/
/*--------------------------------------------------------------*/
public static SuperLongList makeCountList(Collection<Barcode> barcodes) {
SuperLongList sll=new SuperLongList(100000);
for(Barcode b : barcodes) {
sll.increment(b.count());
}
sll.sort();
return sll;
}
/**
* The goal of this function is to return a count such that
* only percentile of observed barcodes have counts below that.
* @param barcodes
* @param percentile
* @return
*/
public static long barcodeCountPercentile(Collection<Barcode> barcodes, float percentile) {
//Just an example; don't call it directly.
SuperLongList sll=makeCountList(barcodes);
long x=sll.percentileValueBySum(percentile);//TODO: Note - this is untested and gives assertion error.
assert(false) : x; //Make sure this returns the count described in the annotation, not +1 or -1.
return x;
}
/*--------------------------------------------------------------*/
/*---------------- Static Fields ----------------*/
/*--------------------------------------------------------------*/
public static boolean errorState=false;
}
|