496e6d0ac50bc1eab5f38ebaa0da717119f712d4
tdreszer
  Tue Nov 2 14:45:35 2010 -0700
Added raReadWithFilter to read an ra file and collect a set of related stanza.  Useful for cv.ra processing to get all antibodies or all cells
diff --git src/inc/ra.h src/inc/ra.h
index 200c177..4e8d085 100644
--- src/inc/ra.h
+++ src/inc/ra.h
@@ -1,57 +1,62 @@
 /* Stuff to parse .ra files. Ra files are simple text databases.
  * The database is broken into records by blank lines. 
  * Each field takes a line.  The name of the field is the first
  * word in the line.  The value of the field is the rest of the line. 
  *
  * This file is copyright 2002 Jim Kent, but license is hereby
  * granted for all use - public, private or commercial. */
 
 #ifndef RA_H
 
 struct hash *raNextRecord(struct lineFile *lf);
 /* Return a hash containing next record.   
  * Returns NULL at end of file.  freeHash this
  * when done.  Note this will free the hash
  * keys and values as well, so you'll have to
  * cloneMem them if you want them for later. */
 
 struct slPair *raNextRecordAsSlPairList(struct lineFile *lf);
 /* Return ra record as a slPair list instead of a hash.  Handy if you want to preserve the order. 
  * Do a slPairFreeValsAndList on result when done. */
 
 boolean raSkipLeadingEmptyLines(struct lineFile *lf, struct dyString *dy);
 /* Skip leading empty lines and comments.  Returns FALSE at end of file. 
  * Together with raNextTagVal you can construct your own raNextRecord.... 
  * If dy parameter is non-null, then the text parsed gets placed into dy. */
 
 boolean raNextTagVal(struct lineFile *lf, char **retTag, char **retVal, struct dyString  *dy);
 /* Read next line.  Return FALSE at end of file or blank line.  Otherwise
  * fill in *retTag and *retVal and return TRUE.
  * If dy parameter is non-null, then the text parsed gets appended to dy. */
 
 struct hash *raFromString(char *string);
 /* Return hash of key/value pairs from string.
  * As above freeHash this when done. */
 
 boolean raFoldInOne(struct lineFile *lf, struct hash *hashOfHash);
 /* Fold in one record from ra file into hashOfHash. 
  * This will add ra's and ra fields to whatever already
  * exists in the hashOfHash,  overriding fields of the
  * same name if they exist already. */
 
 void raFoldIn(char *fileName, struct hash *hashOfHash);
 /* Read ra's in file name and fold them into hashOfHash. 
  * This will add ra's and ra fields to whatever already
  * exists in the hashOfHash,  overriding fields of the
  * same name if they exist already. */
 
 struct hash *raReadSingle(char *fileName);
 /* Read in first ra record in file and return as hash. */
 
 struct hash *raReadAll(char *fileName, char *keyField);
 /* Return hash that contains all ra records in file keyed
  * by given field, which must exist.  The values of the
  * hash are themselves hashes. */
 
+struct hash *raReadWithFilter(char *fileName, char *keyField,char *filterKey,char *filterValue);
+/* Return hash that contains all filtered ra records in file keyed by given field, which must exist.
+ * The values of the hash are themselves hashes.  The filter is a key/value pair that must exist.
+ * Example raReadWithFilter(file,"term","type","antibody"): returns hash of hashes of every term with type=antibody */
+
 #endif /* RA_H */