Added capability to deal with locations enclosed in parentheses, like
[bioperl-live.git] / Changes
blobd1b657399ff46cbc834e5126aa2261851a632039
1 $Id$
2 Revision history for Bioperl core modules
4 1.1 Developer release 
6     o Bio::Tools::Run has been broken off into a new pkg bioperl-run,
7       this separation removes some of the complexity in our test suite
8       and separates the core modules in bioperl from those that need
9       external programs to run.
11     o With latest ExtUtils::MakeMaker module installed SGI/IRIX should
12       not run into trouble running the makefile
14     o Bio::Location and Bio::SeqIO::FTHelper are fixed to properly 
15       read,create,and write locations for grouped/split locations
16       (like mRNA features on genomic sequence).  
18     o Bio::Tools::Phlyo added for wrappers for parsing Molphy (protml)
19       and PAML (codeml,aaml, etc) parsing.
21     o Bio::Tree:: objects expanded to handle testing monophyly,
22       paraphyly, least common ancestor, etc.
24     o Bio::Coordinate for mapping locations from different coordinate spaces 
26     o Bio::SearchIO::waba added for parsing WABA, Bio::SearchIO::hmmer
27       added for parsing hmmpfam and hmmsearch output.
29     o Bio::SearchIO::Writer::TextResultWriter for outputting
30       a pseudo-blast textfile format
33 1.0.2 Bug fix release
35     o Note: The modules Bio::DB::GenBank and Bio::DB::GenPept provided
36       in this release will not work after December 2002 when NCBI
37       shuts off the old Entrez cgi scripts.  We have already fixed
38       on our main development branch and the functionality will be
39       available in the next stable bioperl release (1.2) slated for
40       Fall 2002.
42     o Numerous parsing bugs in Bio::SearchIO::fasta found through 
43       testset by Robin Emig.  These were fixed as was the get_aln
44       method in Bio::Search::HSP::GenericHSP to handle the extra 
45       context sequence that is provided with a FastA alignment.
46     
47     o Migrating differences between Bio::Search::XX::BlastXX to 
48       Bio::Search::XX::GenericXX objects.  This included mechanism
49       to retrieve whole list of HSPs from Hits and whole list of Hits from 
50       Results in addition to the current next_XX iterator methods that
51       are available.  Added seq_inds() method to GenericHSP which identifies
52       indexes in the query or hit sequences where conserved,identical,gaps, 
53       or mismatch residues are located (adapted from Steve Chervitz's 
54       implementation in BlastHSP).
56     o Bio::DB::GFF bugs fixed and are necessary for latest GBrowse release.
57       Bio::DB::GFF::RelSegment is now Bio::SeqI compliant.
58       
59     o Bio::Graphics glyph set improved and extended for GBrowse release
61     o Bio::Tree::Tree get_nodes implementation improvement thanks
62       to Howard Ross notice performance problem when writing out 
63       unbalanced trees.
65     o Bio::Location::Fuzzy::new named parameter -loc_type became
66       -location_type, Bio::Location::Simple::new named parameter
67       -seqid becamse -seq_id.
68    
69     o Fixed major Bio::AlignIO::emboss parsing bug on needle output,
70       was mis-detecting that gaps should be placed at the beginning of
71       the alignment when the best alignment starts internally in the
72       sequence.
74 1.0.1 Bug fix release
75         
76     o Minor bug fixes to Bio::DB:GFF.  Glyph sets improved.
78     o Parser fixes in SearchIO blast, fasta for more complete WU BLAST 
79       and mixed (3.3 - 3.4) versions of FASTA.
81     o Small API change to add methods for completeness across 
82       implementations of Bio::Search objects.  These new methods
83       in the interface are implemented by the GenericXX object as well  
84       as the BlastXX objects.
85         * Bio::Search::Result::ResultI 
86          - hits() method returns list of all Hits (next_hit is an 
87            iterator method)
88                 
89         * Bio::Search::Hit::HitI
90          - hsps() method returns list of all HSPs (next_hsp is an 
91            iterator method)
92         
93     o The Bio::SearchIO::Writer classes have been fixed to handle results 
94        created from either psiblast (Search::BlastXX objects) or 
95        blast|fasta|blastxml objects (Search::GenericXX objects).  More work 
96        has to be done here to make it work properly and will nee major 
97        API changes.
99     o Bugs in Bio::Tools::HMMER fixed, including
100        * #1178 - Root::IO destructor wasn't being called
101        * #1034 - filter_on_cutoff now behaves properly
103     o Bio::SeqFeature::Computation initialization args fixed and 
104       tests added.
106     o Tests are somewhat cleaner, flat.t now properly cleans up after itsself,
107       
108     o Updated FAQ with more example based answers to typical questions
110     o Bug #1202 was fixed which would improperly join together qual values
111       parsed by Bio::SeqIO::qual when a trailing space was not present before
112       the newline.
114 1.0.0 Major Stable Release
116   This represents a major release of bioperl with significant
117   improvements over the 0.7.x series of releases.   
119     o Bio::Tools::Blast is officially deprecated.  Please see
120       Bio::SearchIO for BLAST and FastA parsing.
122     o The methods trunc() and subseq() in Bio::PrimarySeqI now accepts
123       Bio::LocationI objects as well as start/end.
125     o Bio::Biblio contains modules for Bibliographic data. 
126       Bio::DB::Biblio contains the query modules.  Additionally one can
127       parse medlinexml from the ebi bibliographic query service (BQS)
128       system and Pubmed xml from NCBI.  See Martin Senger's
129       documentation in Bio::Biblio for more information.
130     
131     o Bio::DB::Registry is a sequence database registry part of 
132       Open Bioinformatics Database Access.  See
133       http://obda.open-bio.org for more information.
134     
135     o File-based and In-Memory Sequence caching is provided by
136       Bio::DB::InMemoryCache and Bio::DB::FileCache which acts like a
137       local database.
139     o Bio::Graphics for rendering sequences as PNG,JPG, or GIFs has
140       been added by Lincoln Stein.
142     o XEMBL SOAP service access in provided in Bio::DB::XEMBL.
144     o A FAQ has been started and is included in the release to provide
145       a starting point for frequent questions and issues.
147 0.9.3 Developer's release
148     
149     o Event based parsing system improved (SearchIO).  With parsers for
150       XML Blast (blastxml), Text Blast (blast), and FASTA results (fasta).  
151       Additionally a lazy parsing system for text and html blast reports was
152       added and is called psiblast (name subject to change in future releases).
154     o Bio::Search objects improved and standardized with associated Interfaces
155       written.  The concept of a search "Hit" was standardized to be called
156       "hit" consistently and the use of "subject" was deprecated in all active
157       modules.
159     o Bio::Structure added (since 0.9.1) for Protein structure objects 
160       and PDB parser to retrieve and write these structures from data files. 
162     o Several important Bio::DB::GFF bug fixes for handling features that
163       are mapped to multiple reference points.  Updated mysql adaptor
164       so as to be able to store large (>100 megabase) chunks of DNA into
165       Bio::DB::GFF databases.
167 0.9.2 Developer's release
169     o Bio::Search and Bio::SearchIO system introduced for event based
170       parsing of Blast,Fasta reports Bio::SearchIO supports ncbi BLAST
171       in text and XML and FASTA reports in standard output format.
173     o Bio::Tree and Bio::TreeIO for phylogenetic trees.  A Random tree
174       generator is included in Bio::TreeIO::RandomTrees and a
175       statistics module for evaluating.
176       
177     o Bio::DB::GFF, Lincoln Stein's GFF database suitable as a DB
178       server for DAS servers.
180     o Bio::Tools::BPlite is provides more robust parsing of BLAST
181       files.  The entire BPlite system migrated to using Bio::Root::IO
182       for the data stream.
183         
184     o Bio::Tools::Alignment for Consed and sequence Trimming
185       functionality.
187     o Bio::Structure for Protein structure information and parsing
189     o Bio::DB::GenBank/Bio::DB::GenPept updated to new NCBI Entrez
190       cgi-bin entry point which should be more reliable.
191    
192     o Bio::Map and Bio::MapIO for biological map navigation and a
193       framework afor parsing them in.  Only preliminary work here.
195     o Interface for executing EMBOSS programs locally in Bio::Factory::EMBOSS
196       Future work will integrate Pise and allow submission of analysis on
197       remote servers.
199     o Bio::AnnotationCollectionI and Bio::Annotation::Collection
200       introduced as new objects for handling Sequence Annotation
201       information (dblinks, references, etc) and is more robust that
202       previous system.
204     o Bio::Tools::FASTAParser introduced.
206     o Scripts from the bioperl script submission project and new
207       scripts from bioperl authors are included in "scripts" directory.
209     o Factory objects and interfaces are being introduced and are more
210       strictly enforced.
211         
212     o Bio::Root::Root introduced as the base object while
213       Bio::Root::RootI is now simply an interface.
215     o Bio::DB::RefSeq provides database access to copy of the NCBI
216       RefSeq database using the EBI dbfetch script.
218 0.9.0 Developer's release
220     o perl version at least 5.005 is now required instead of perl 5.004
222     o Bio::Tools::Run::RemoteBlast is available for running remote 
223       blast jobs at NCBI.
225     o Bio::Tools::BPbl2seq was fixed to handle multiple HSPs.
227     o Bio::SeqFeature::GeneStructure migrated to Bio::SeqFeature::Gene.
228       Also added are related modules UTR3, UTR5, Exon, Intron, 
229       Promotor, PolyA and Transcript.
231     o Speedup of translate method in PrimarySeq     
233     o Bio::SimpleAlign has new methods: location_from_column(), slice(),
234       select(), dot(), get_seq_by_pos(), column_from_residue_number()
236     o Various fixes to Variation toolkit
237     
238     o Bio::DB::EMBL provides database access to EMBL sequence data.
239       Bio::DB::Universal provides a central way to point to indexes
240       and dbs in a single interface.
242     o Bio::DB::GFF - a database suitable for running DAS servers locally.
244     o Bio::Factory::EMBOSS is still in design phase as is  
245       Bio::Factory::ApplicationFactoryI
247     o Dia models for bioperl design are provided in the models/ directory
249 0.7.2 Bug fix release
251     o documentation fixes in many modules - SYNOPSIS code verified 
252       to be runnable in many (but not all modules)
254     o corrected MANIFEST file from 0.7.1 release
255    
256     o Bug fix in Bio::SeqIO::FTHelper to properly handle
257       split locations
259     o Bio::SeqIO::genbank 
260         * Correct parsing and writing of genbank format with protein data
261         * moltype and molecule separation                          
263     o Bio::SeqIO::largefasta fix to avoid inifinite loops
264         
265     o Bio::SimpleAlign fixed to correctly handle consensus 
266       sequence calculation
268     o Bio::Tools::HMMER supports hmmer 2.2g
270     o Bio::Tools::BPlite to support report type specific parsing.  Most 
271       major changes are not on the 0.7 branch.
272    
273     o Bio::Tools::Run::StandAloneBlast exists_blast() fixed and works 
274       with File::Spec 
276     o Bio::Variation::AAChange/RNAChange corrected labels and mutated alleles 
277         in several types of mutations:
278         1.) AA level: deletion, complex
279         2.) AA level: complex, inframe
280         3.) RNA level: silent
282     o  BPbl2seq parsing of empty reports will not die, but will return
283        a valid, empty, Bio::SeqFeature::SimilarityFeature for
284        $report->query() and $report->subject() methods.  So an easy
285        way to test if report was empty is to see if
286        $report->query->seqname is undefined.
288 0.7.1 Bug fix release 
290     o Better parsing of genbank/EMBL files especially fixing bugs
291       related to Feature table parsing and locations on remote
292       sequences.  Additionally, species name parsing was better.
294     o Bio::SeqIO::genbank can parse now NCBI produced genbank database
295       which include a number of header lines.
297     o More strict genbank and EMBL format writing (corrected number of
298       spaces where appropriate).
300     o Bio::Tools::BPlite can better parse BLASTX reports - see BUGS
301       for related BPlite BUGS that are unresolved in this release.
302   
303     o Bio::DB::GenBank, Bio::DB::GenPept have less problems
304       downloading sequences from NCBI via HTTP.  Bio::DB::SwissProt can
305       use expasy mirrors or EBI dbfetch cgi-script.
307     o A moderate number of documentation improvements were made as
308       well to provide a better code synopsis in each module.
311 0.7  Large number of changes, including refactoring of the
312      Object system, new parsers, new functionality and
313      all round better system. Highlights are:
316      o Refactored root of inheritance: moved to a lightweight Bio::Root::RootI;
317        Bio::Root::IO for I/O and file/handle capabilities.
319      o Imported BPlite modules from Ian Korf for BLAST
320        parsing. This is considered the supported BLAST parser;
321        Bio::Tools::Blast.pm will eventually phase out due to lack of support.
323      o Improved Sequence Feature model. Added complete location
324        modelling (with fuzzy and compound locations).  See
325        Bio::LocationI and the modules under Bio/Location.  Added
326        support in Genbank/EMBL format parsing to completely parse
327        feature tables for complex locations.
329      o Moved special support for databanks etc to specialized modules under
330        Bio/Seq/. One of these supports very large sequences through 
331        a temporary file as a backend.
333      o Explicit Gene, Transcript and Exon SeqFeature objects, supporting
334        CDS retrieval and exon shuffling.
336      o More parsers: Sim4, Genscan, MZEF, ESTScan, BPbl2seq, GFF
338      o Refactored Bio/DB/GenBank+GenPept. There is now also DB/SwissProt and
339        DB/GDB (the latter has platform-specific limitations).
341      o New analysis parser framework for HT sequence annotation (see
342        Bio::SeqAnalysisParserI and Bio::Factory::SeqAnalysisParserFactory)
344      o New Alignment IO framework
346      o New Index modules (Swissprot)
348      o New modules for running Blast within perl
349        (Bio::Tools::Run::StandAloneBlast). Added modules for running
350        Multiple Sequence Alignment tools ClustalW and TCoffee
351        (Bio::Tools::Run::Alignment).
353      o New Cookbook-style tutorial (see bptutorial.pl). Improved
354        documentation across the package.
356      o Much improved cross platform support. Many known incompatibilities
357        have been fixed; however, NT and Mac do not work across the entire
358        setup (see PLATFORMS).
360      o Many bug fixes, code restructuring, etc. Overall stability and
361        maintainability benefit a lot.
363      o A total of 957 automatic tests
364     
366 0.6.2  
368    There are very few functionality changes but a large
369    number of software improvements/bug fixes across the package.
371    o The EMBL/GenBank parsing are improved.
373    o The Swissprot reading is improved. Swissprot writing
374      is disabled as it doesn't work at all. This needs to
375      wait for 0.7 release
377    o BLAST reports with no hits are correctly parsed.
379    o Several other bugs of the BLAST parser (regular expressions, ...)
380      fixed.
382    o Old syntax calls have been replaced with more modern syntax
384    o Modules that did not work at all, in particular the Sim4
385      set have been removed
387    o Bio::SeqFeature::Generic and Bio::SeqFeature::FeaturePair
388      have improved compliance with interface specs and documentation
390    o Mailing list documentation updated throughout the distribution
392    o Most minor bug fixes have happened.
394    o The scripts in /examples now work and have the modern syntax
395      rather than the deprecated syntax
398 0.6.1  Sun April 2 2000
400    o Sequences can have Sequence Features attached to them
401         - The sequence features can be read from or written to
402           EMBL and GenBank style flat files
404    o Objects for Annotation, including References (but not
405      full medline abstracts), Database links and Comments are
406      provided
408    o A Species object to represent nodes on a taxonomy tree
409      is provided
411    o The ability to parse HMMER and Sim4 output has been added
413    o The Blast parsing has been improved, with better PSI-BLAST
414      support and better overall behaviour.
416    o Flat file indexed databases provide both random access 
417      and sequential access to their component sequences.
419    o A CodonTable object has been written with all known 
420      CodonTables accessible.
422    o A number of new lightweight analysis tools have been
423      added, such as molecular weight determination.
425     The 0.6 release also has improved software engineering
426   
427    o The sequence objects have been rewritten, providing more
428      maintainable and easier to implement objects. These
429      objects are backwardly compatible with the 0.05.1 objects
431    o Many objects are defined in terms of interfaces and then  
432      a Perl implementation has been provided. The interfaces
433      are found in the 'I' files (module names ending in 'I').
435      This means that it is possible to wrap C/CORBA/SQL access
436      as true "bioperl" objects, compatible with the rest of
437      bioperl.
439    o The SeqIO system has been overhauled to provide better
440      processing and perl-like automatic interpretation of <>
441      over arguments.
443    o Many more tests have been added (a total of 172 automatic
444      tests are now run before release).
448 0.05.1 Tue Jun 29 05:30:44 1999
449         - Central distribution now requires Perl 5.004. This was
450           done to get around 5.003-based problems in Bio/Index/* 
451           and SimpleAlign.
452         - Various bug fixes in the Bio::Tools::Blast modules
453           including better exception handling and PSI-Blast 
454           support. See Bio/Tools/Blast/CHANGES for more.
455         - Fixed the Parse mechanism in Seq.pm to use readseq.
456           Follow the instructions in README for how to install
457           it (basically, you have to edit Parse.pm).
458         - Improved documentation of Seq.pm, indicating where 
459           objects are returned and where strings are returned.
460         - Fixed uninitialized warnings in Bio::Root::Object.pm
461           and Bio::Tools::SeqPattern.pm.
462         - Bug fixes for PR#s: 30,31,33-35,41,42,44,45,47-50,52.
464 0.05  Sun Apr 25 01:14:11 1999
465         - Bio::Tools::Blast modules have less memory problems
466           and faster parsing. Webblast uses LWP and supports
467           more functionality. See Bio/Tools/Blast/CHANGES for more.
468         - The Bio::SeqIO system has been started, moving the
469           sequence reformatting code out of the sequence object
470         - The Bio::Index:: system has been started, providing
471           generic index capabilities and specifically works for
472           Fasta formatted databases and EMBL .dat formatted 
473           databases
474         - The Bio::DB:: system started, providing access to 
475           databases, both via flat file + index (see above) and
476           via http to NCBI
477         - The scripts/ directory, where industrial strength scripts
478           are put has been started.
479         - Many changes - a better distribution all round.
481 0.04.4  Wed Feb 17 02:20:13 1999
482         - Bug fixes in the Bio::Tools::Blast modules and postclient.pl
483           (see Bio::Tools::Blast::CHANGES).
484         - Fixed a bug in Bio::Tools::Fasta::num_seqs().
485         - Beefed up the t/Fasta.t test script.
486         - Small fix in Bio::Seq::type() (now always returns a string).
487         - Changed Bio::Root::Utilities::get_newline_char() to 
488           get_newline() since it could return more than one char.
489         - Added $NEWLINE and $TIMEOUT_SECS to Bio::Root::Global.
490         - Changed default timeout to 20 seconds (was 3).
491         - Moved lengthy modification notes to the bottom of some files.
492         - Fixed SimpleAlign write_fasta bug.
493         - Beefed up SimpleAlign.t test
495 0.04.3  Thu Feb  4 07:48:53 1999
496         - Bio::Root::Object.pm and Global.pm now detect when
497           script is run as a CGI and suppress output that is only
498           appropriate when running interactively.
499         - Bio::Root::Err::_set_context() adds name of script ($0).
500         - Added comments in Bio::Tools::WWW.pm and Bio::Root::Utilities.pm
501           regarding the use of the static objects via the qw(:obj) tag.
502         - Fixed the ambiguous reverse calls in Seq.pm and UnivAln.pm to 
503           CORE::reverse, avoiding Perl warnings.
504         - Bug fixes in Bio::Tools::Blast modules (version 0.074) and 
505           example scripts (see Bio::Tools::Blast::CHANGES).
506         - examples/seq/seqtools.pl no longer always warns about using 
507           -prot or -nucl command-line arguments; only when using the 
508           -debug argument.
509         - Methods added to Bio::Root::Utilities: create_filehandle(), 
510           get_newline_char(), and taste_file() to generalize filehandle 
511           creation and autodetect newline characters in files/streams
512           (see bug report #19).
513         - Bio::Root::IOManager::read() now handles timeouts and uses
514           Utilities::create_filehandle().
515         - Bio::Tools::Fasta.pm uses Utilities::get_newline_char() instead
516           of hardwiring in "\n".
517         - Bug fixes in the Bio::SimpleAlign and Bio::Tools::pSW
519 0.04.2  Wed Dec 30 02:27:36 1998
520         - Bug fixes in Bio::Tools::Blast modules, version 0.073
521           (see Bio::Tools::Blast::CHANGES).
522         - Changed reverse calls in Bio/Seq.pm and Bio/UnivAln.pm
523           to CORE::reverse (prevents ambiguous warnings with 5.005).
524         - Appending '.tmp.bioperl' to temporary files created by
525           Bio::Root::Utilities::compress() or uncompress() to
526           make it easy to identify & cleanup these files as needed.
527         - Developers: Created CVS branch release-0-04-bug from
528           release-0-04-1. Before making bug fixes to the 0.04.1 release,
529           be sure to cvs checkout this branch into a clean area.
531 0.04.1  Wed Dec 16 05:39:15 1998
532         - Bug fixes in Bio::Tools::Blast modules, version 0.072
533           (see Bio::Tools::Blast::CHANGES).
534         - Compile/SW/Makefile.PL now removes *.o and *.a files 
535           with make clean.
537 0.04  Tue Dec  8 07:49:19 1998
538         - Lots of new modules added including:
539            * Ewan Birney's Bio::SimpleAlign.pm, Bio::Tools::AlignFactory.pm,
540              and Bio/Compile directory containing XS-linked C code for
541              creating Smith-Waterman sequence alignments from within Perl.
542            * Steve Chervitz's Blast distribution has been incorporated.
543            * Georg Fuellen's Bio::UnivAln.pm for multiple alignment objects.
544         - Bio/examples directory for demo scripts for all included modules.
545         - Bio/t directory containing test suit for all included modules.
546         - For changes specific to the Blast-related modules prior to
547           incorporation in this central distribution, see the CHANGES
548           file in the Bio/Tools/Blast directory.
549      
550 0.01  Tue Sep  8 14:23:22 1998
551         - original version from central CVS tree; created by h2xs 1.18