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
|
package tax;
import java.io.File;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.regex.Pattern;
import fileIO.TextFile;
import shared.KillSwitch;
import shared.Parse;
import shared.PreParser;
import shared.Tools;
import stream.Read;
/**
* @author Brian Bushnell
* @date Nov 30, 2015
*
*/
public class TaxFilter {
public static void main(String[] args){
String regex=args[0];
String s=args[1];
Pattern regexPattern=Pattern.compile(regex);
boolean b=regexPattern.matcher(s).matches();
System.err.println(regex);
System.err.println(s);
System.err.println(b);
}
/*--------------------------------------------------------------*/
/*---------------- Constructors ----------------*/
/*--------------------------------------------------------------*/
/**
* Constructor.
* @param args Command line arguments
*/
public static TaxFilter makeFilter(String[] args){
{//Preparse block for help, config files, and outstream
PreParser pp=new PreParser(args, new Object() { }.getClass().getEnclosingClass(), false);
args=pp.args;
outstream=pp.outstream;
}
String names=null;
String ids=null;
String giTableFile=null;
String taxTreeFile=null;
String accessionFile=null;
int taxLevelE=-1;
int reqLevels=0;
boolean include=false;
boolean promote=true;
String regex=null;
String contains=null;
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(a.equals("table") || a.equals("gi")){
giTableFile=b;
}else if(a.equals("tree") || a.equals("taxtree")){
taxTreeFile=b;
}else if(a.equals("accession")){
accessionFile=b;
}else if(a.equals("level") || a.equals("lv") || a.equals("taxlevel") || a.equals("tl")){
taxLevelE=TaxTree.parseLevelExtended(b);
// System.err.println("Set taxLevelE = "+TaxTree.levelToStringExtended(taxLevelE)); //123
}else if(a.equals("reqlevel") || a.equals("requiredlevel") || a.equals("reqlevels") || a.equals("requiredlevels")){
assert(b!=null) : "Bad parameter: "+arg;
String[] split2=b.toLowerCase().split(",");
reqLevels=0;
for(String s : split2){
int level=TaxTree.parseLevel(s);
reqLevels|=(1<<level);
}
}else if(a.equals("name") || a.equals("names")){
names=b;
}else if(a.equals("regex")){
regex=b;
}else if(a.equals("contains")){
contains=b;
}else if(a.equals("printnodesadded") || a.equals("printnodes")){
printNodesAdded=Parse.parseBoolean(b);
}else if(a.equals("promote")){
promote=Parse.parseBoolean(b);
}else if(a.equals("include")){
include=Parse.parseBoolean(b);
}else if(a.equals("exclude")){
include=!Parse.parseBoolean(b);
}else if(a.equals("requirepresent")){
REQUIRE_PRESENT=Parse.parseBoolean(b);
TaxTree.SHOW_WARNINGS=REQUIRE_PRESENT;
}else if(a.equals("id") || a.equals("ids") || a.equals("taxid") || a.equals("tid") || a.equals("taxids")){
ids=b;
}
}
if("auto".equalsIgnoreCase(taxTreeFile)){taxTreeFile=TaxTree.defaultTreeFile();}
if("auto".equalsIgnoreCase(giTableFile)){giTableFile=TaxTree.defaultTableFile();}
if("auto".equalsIgnoreCase(accessionFile)){accessionFile=TaxTree.defaultAccessionFile();}
TaxTree tree=loadTree(taxTreeFile);
loadGiTable(giTableFile);
loadAccession(accessionFile, tree);
TaxFilter filter=new TaxFilter(tree, taxLevelE, reqLevels, include, promote, null, regex, contains);
filter.addNames(names);
filter.addNumbers(ids, true);
return filter;
}
/**
* Constructor.
* @param tree_
*/
public TaxFilter(TaxTree tree_, boolean include_){
this(tree_, -1, 0, include_, true, null, null, null);
}
/**
* Constructor.
*/
public TaxFilter(TaxTree tree_, int taxLevelE_, int reqLevels_, boolean include_, boolean promote_,
HashSet<Integer> taxSet_, String regex_, String contains_){
tree=tree_;
taxLevelE=taxLevelE_;
reqLevels=reqLevels_;
include=include_;
promote=promote_;
taxSet=(taxSet_==null ? new HashSet<Integer>() : taxSet_);
regex=regex_;
regexPattern=(regex==null ? null : Pattern.compile(regex));
containsString=contains_;
}
/** Alter taxSet and taxLevel to ensure they intersect with the file contents. */
public void reviseByBestEffort(String fname){
HashSet<Integer> desired=new HashSet<Integer>();
int currentLevelE=taxLevelE;
for(int i : taxSet){
int x=tree.getIdAtLevelExtended(i, currentLevelE);
desired.add(x);
}
HashSet<Integer> present=new HashSet<Integer>();
TextFile tf=new TextFile(fname);
for(String line=tf.nextLine(); line!=null; line=tf.nextLine()){
if(line.startsWith(">")){
TaxNode tn=tree.parseNodeFromHeader(line.substring(1), true);
if(tn!=null){
present.add(tree.getIdAtLevelExtended(tn.id, currentLevelE));
}
}
}
while(currentLevelE<TaxTree.LIFE_E){
//Intersect
for(Integer i : desired){
if(present.contains(i)){
if(currentLevelE!=taxLevelE){System.err.println("Widened filter from "+
TaxTree.levelToStringExtended(taxLevelE)+" to "+TaxTree.levelToStringExtended(currentLevelE));}
taxLevelE=currentLevelE;
taxSet=desired;
return;
}
}
currentLevelE++;
HashSet<Integer> desired2=new HashSet<Integer>();
for(int i : desired){
desired2.add(tree.getIdAtLevelExtended(i, currentLevelE));
}
desired=desired2;
HashSet<Integer> present2=new HashSet<Integer>();
for(int i : present){
present2.add(tree.getIdAtLevelExtended(i, currentLevelE));
}
present=present2;
}
}
public static boolean validArgument(String a){
if(a.equals("table") || a.equals("gi")){
}else if(a.equals("tree") || a.equals("taxtree")){
}else if(a.equals("accession")){
}else if(a.equals("taxpath")){
}else if(a.equals("level") || a.equals("lv") || a.equals("taxlevel") || a.equals("tl")){
}else if(a.equals("name") || a.equals("names")){
}else if(a.equals("regex")){
}else if(a.equals("contains")){
}else if(a.equals("besteffort")){
}else if(a.equals("include")){
}else if(a.equals("promote")){
}else if(a.equals("exclude")){
}else if(a.equals("printnodesadded") || a.equals("printnodes")){
}else if(a.equals("id") || a.equals("ids") || a.equals("taxid") || a.equals("tid") || a.equals("taxids")){
}else if(a.equals("requirepresent")){
}else if(a.equals("reqlevel") || a.equals("requiredlevel") || a.equals("reqlevels") || a.equals("requiredlevels")){
}else{
return false;
}
return true;
}
/*--------------------------------------------------------------*/
/*---------------- Initialization ----------------*/
/*--------------------------------------------------------------*/
private static void loadAccession(String accessionFile, TaxTree tree){
if(accessionFile!=null){
AccessionToTaxid.tree=tree;
assert(tree!=null);
outstream.println("Loading accession table.");
AccessionToTaxid.load(accessionFile);
System.gc();
}
}
public static void loadGiTable(String fname){
if(fname==null){return;}
if(PRINT_STUFF){outstream.println("Loading gi table.");}
GiToTaxid.initialize(fname);
}
public static TaxTree loadTree(String fname){
if(fname==null){return null;}
TaxTree tt=TaxTree.loadTaxTree(fname, PRINT_STUFF ? outstream : null, true, false);
assert(tt.nameMap!=null);
return tt;
}
public void addNamesOrNumbers(String names, boolean promote){
if(names==null){return;}
String[] array=names.split(",");
for(String name : array){
addNameOrNumber(name, promote);
}
}
public void addNameOrNumber(String s, boolean promote){
if(s==null || s.length()<1){return;}
if(Tools.isDigit(s.charAt(0))){addNumber(Integer.parseInt(s), promote);}
else{addName(s);}
}
public void addNames(String names){
if(names==null){return;}
String[] array=names.split(",");
for(String name : array){
addName(name);
}
}
public boolean addName(String name){
{
TaxNode tn=tree.parseNodeFromHeader(name, true);
if(tn!=null){return addNode(tn);}
}
List<TaxNode> list=tree.getNodesByNameExtended(name);
boolean success=false;
assert(list!=null) : "Could not find a node for '"+name+"'";
if(list==null){throw new RuntimeException("Could not find a node for '"+name+"'");}
for(TaxNode tn : list){
success=addNode(tn)|success;
}
return success;
}
public void addNumbers(String numbers, boolean promote){
if(numbers==null){return;}
String[] array=numbers.split(",");
for(String s : array){
if(Tools.isDigit(s.charAt(0))){
final int x=Integer.parseInt(s);
addNumber(x, promote);
}else if(new File(s).exists()){
TextFile tf=new TextFile(s);
for(String line=tf.nextLine(); line!=null; line=tf.nextLine()){
addNumbers(line, promote);
}
}else{
assert(tree!=null) : "Using organism names requires a taxonomic tree loaded; please use a numeric NCBI taxID.";
final int x=tree.parseNameToTaxid(s);
assert(x>0) : "Can't find a tax node for "+s;
addNumber(x, promote);
}
}
}
public boolean addNumber(int taxID, boolean promote){
if(promote){
TaxNode tn=tree.getNode(taxID);
assert(tn!=null) : "Could not find a node for '"+taxID+"'";
return addNode(tn);
}else{
maxChildLevelExtended=TaxTree.LIFE_E;
return taxSet.add(taxID);
}
}
public boolean addNode(TaxNode tn){
if(tn==null){return false;}
taxSet.add(tn.id);
maxChildLevelExtended=Tools.max(maxChildLevelExtended, tn.maxChildLevelExtended, tn.levelExtended);
if(printNodesAdded){System.err.println("Added node "+tn);}//123
while(tn.id!=tn.pid && tn.levelExtended<taxLevelE){
tn=tree.getNode(tn.pid);
if(tn.levelExtended<=taxLevelE){
if(printNodesAdded){System.err.println("Added node "+tn);}//123
taxSet.add(tn.id);
}
}
return true;
}
/*--------------------------------------------------------------*/
/*---------------- Outer Methods ----------------*/
/*--------------------------------------------------------------*/
public boolean passesFilter(final Read r){
return passesFilter(r.id);
}
public boolean passesFilterByNameOnly(final String name){
if(regexPattern!=null){
boolean b=matchesRegex(name);
if(b!=include){return false;}
}
if(containsString!=null){
boolean b=containsString(name);
if(b!=include){return false;}
}
return true;
}
public boolean passesFilter(final String name){
if(!passesFilterByNameOnly(name)){return false;}
if(taxSet.isEmpty() && reqLevels==0){return !include;}
TaxNode tn=tree.parseNodeFromHeader(name, true);
if(tn==null){tn=tree.getNodeByName(name);}
// assert(tn!=null || !REQUIRE_PRESENT) : "Could not find node for '"+name+"'";
if(REQUIRE_PRESENT && tn==null){
KillSwitch.kill("ERROR: Could not find node for '"+name+"'"
+ "\nTo bypass this error, add the flag 'requirepresent=f'");
}
// assert(false) : passesFilter(tn);
return passesFilter(tn);
}
public boolean passesFilter(final int id){
// if((taxSet==null || taxSet.isEmpty()) && reqLevels==0){return !include;}
if((taxSet==null || taxSet.isEmpty()) && reqLevels==0){return true;}
TaxNode tn=tree.getNode(id);
// assert(tn!=null || !REQUIRE_PRESENT) : "Could not find node number "+id;
if(tn==null){
if(REQUIRE_PRESENT){
KillSwitch.kill("ERROR: Could not find node for "+id);
}else if(WARN_ABSENT_NODE){
System.err.println("Warning: Could not find node for "+id);
WARN_ABSENT_NODE=false;
}
}
return passesFilter(tn);
}
boolean passesFilter(final TaxNode tn0){
TaxNode tn=tn0;
if(taxSet.isEmpty() && reqLevels==0){return !include;}
if(tn==null){
assert(!REQUIRE_PRESENT) : "Null TaxNode.";
return !include && reqLevels==0;
}
boolean found=taxSet.contains(tn.id);
// System.err.println("found="+found+", node="+tn);
int levels=1<<tn.level;
while((!found || (levels&reqLevels)!=reqLevels) && tn.id!=tn.pid){
tn=tree.getNode(tn.pid);
levels|=(1<<tn.level);
if(promote){found=found||taxSet.contains(tn.id);}
// System.err.println("found="+found+", node="+tn);
}
// assert(false) : levels+", "+reqLevels+", "+tn0+", "+tree.getAncestors(tn0.pid);
return include==found && (levels&reqLevels)==reqLevels;
}
public boolean passesFilterFast(final int id){
assert(reqLevels==0);
if(taxSet==null || taxSet.isEmpty()){return true;}
TaxNode tn=tree.getNode(id);
if(tn==null){
if(REQUIRE_PRESENT){
KillSwitch.kill("ERROR: Could not find node for "+id);
}else if(WARN_ABSENT_NODE){
System.err.println("Warning: Could not find node for "+id);
WARN_ABSENT_NODE=false;
}
}
return passesFilterFast(tn);
}
boolean passesFilterFast(final TaxNode tn0){
TaxNode tn=tn0;
if(taxSet==null || taxSet.isEmpty()){return true;}
if(tn==null){
assert(!REQUIRE_PRESENT) : "Null TaxNode.";
return !include;
}
boolean found=taxSet.contains(tn.id);
if(!promote){return include==found;}
while(!found && tn.maxChildLevelExtended<=maxChildLevelExtended && tn.id!=tn.pid){
tn=tree.getNode(tn.pid);
found=found||taxSet.contains(tn.id);
}
return include==found;
}
boolean matchesRegex(String s){
return regexPattern.matcher(s).matches();
}
boolean containsString(String s){
return s.toLowerCase().contains(containsString);
}
/*--------------------------------------------------------------*/
/*---------------- Clone ----------------*/
/*--------------------------------------------------------------*/
public TaxFilter deepCopy() {
TaxFilter copy=null;
try {
copy=(TaxFilter) this.clone();
if(taxSet!=null){
copy.taxSet=new HashSet<Integer>();
copy.taxSet.addAll(taxSet);
}
} catch (CloneNotSupportedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return copy;
}
public void clearSet(){
taxSet=null;
}
public void makeSet(){
taxSet=new HashSet<Integer>();
}
// public void setInclude(boolean b){
// include=b;
// }
public void setLevel(final int newLevel, boolean promote){
final int newLevelE=TaxTree.levelToExtended(newLevel);
assert(newLevelE>=taxLevelE || newLevelE<1 || taxSet==null && taxSet.isEmpty()) : "taxLevel may only be increased when the set is non-empty.";
taxLevelE=newLevelE;
if(promote){promote();}
}
public void promote(){
if(taxSet!=null && !taxSet.isEmpty() && taxLevelE>0){
ArrayList<Integer> list=new ArrayList<Integer>(taxSet.size());
list.addAll(taxSet);
taxSet.clear();
for(Integer i : list){addNumber(i, true);}
}
}
public int size(){return (taxSet==null ? 0 : taxSet.size());}
public int taxLevel(){return TaxTree.extendedToLevel(taxLevelE);}
public Integer[] taxSet(){
return (taxSet==null || taxSet.isEmpty()) ? null : taxSet.toArray(new Integer[0]);
}
public boolean include(){return include;}
public void setTree(TaxTree tree_){tree=tree_;}
public TaxTree tree(){return tree;}
public void setContainsString(String s){containsString=(s==null ? null : s.toLowerCase());}
public String containsString(){return containsString;}
@Override
public String toString(){return ""+taxSet;}
public boolean isEmpty() {return taxSet.isEmpty();}
/*--------------------------------------------------------------*/
/*---------------- Fields ----------------*/
/*--------------------------------------------------------------*/
private TaxTree tree;
/** Level at which to filter */
private int taxLevelE;
/** Branch must contain ancestors at these levels (bitflag) */
private final int reqLevels;
/** Set of numeric NCBI TaxIDs */
private HashSet<Integer> taxSet;
private int maxChildLevelExtended=TaxTree.LIFE_E;
private final boolean include;
private boolean promote;
private String regex;
private final Pattern regexPattern;
private String containsString;
/*--------------------------------------------------------------*/
/*---------------- Static Fields ----------------*/
/*--------------------------------------------------------------*/
/** Print status messages to this output stream */
private static PrintStream outstream=System.err;
/** Print loading messages */
static boolean PRINT_STUFF=true;
public static boolean REQUIRE_PRESENT=true;
public static boolean WARN_ABSENT_NODE=true;
public static boolean printNodesAdded=true;
}
|