[bug 2682]
[bioperl-live.git] / Changes
blobdd0dd7882174c7cb0dbba4cf761c4183e352d1ca
1 $Id$
2   
3 Revision history for Bioperl core modules
5 Main trunk
7     n/a
9 1.5 series - these releases represent the pre-1.6 releases, the 1.6 series
10     will be branches from the last 1.5.x release. 
12 1.5.2 Developer release
13     Full details of changes since 1.5.1 are available online at:
14     http://www.bioperl.org/wiki/Change_log
15     The following represents a brief overview of the most important changes.
17     o Bio::Map
18       - Overhaul. Brand new system fully allows markers to have multiple
19         positions on multiple maps, and to have relative positions. Should be
20         backward compatible.
21     
22     o Bio::Taxonomy
23       - This module and all the modules in the Taxonomy directory now
24         deprecated in favour of Bio::Taxon and Bio::Tree::Tree
25     
26     o Bio::DB::Taxonomy
27       
28       - Taxonomy.pm
29         * get_Taxonomy_Node() eventually to be deprecated, renamed get_taxon().
30         
31         * New methods ancestor(), each_Descendent() and _handle_internal_id().
32         
33         * Allows for different database modules to create Bio::Taxon objects
34           with the same internal id when the same taxon is requested from each.
35     
36       - flatfile.pm
37         * get_Children_Taxids() is deprecated, superceded by each_Descendent().
38         
39         * No longer includes the fake root node 'root'; there are multiple roots
40           now (10239, 12884, 12908, 29384 and 131567). Consistent with entrez.pm
41     
42       - entrez.pm
43         * get_node() has new option -full
44         
45         * Caches data retrieved from website
46     
47     o Bio::Species
48       - Now a Bio::Taxon. Carries out the species name -> specific name munging
49         that Bio::DB::Taxonomy modules and SeqIO modules used to do, for
50         backward compatability in species() method.
51     
52     o Bio::Search and Bio::SearchIO
53       - Overhaul. The existing system has been sped up via some minor changes
54         (mostly gain-of-function to the API). Bio::PullParserI is introduced
55         as a potential eventual replacment for the existing system, though as
56         yet only a Hmmpfam parser exists written using it.
59 1.5.1 Developer release
61     o Major problem with how Annotations were written out with
62       Bio::Seq is fixed by reverting to old behavior for
63       Bio::Annotation objects.
65     o Bio::SeqIO
67      - genbank.pm
68        * bug #1871; REFLOOP' parsing loop, I changed the pattern to
69          expect at l east 9 spaces at the beginning of a line to
70          indicate line wrapping.
72        * Treat multi-line SOURCE sections correctly, this defect broke
73          both common_name() and classification()
75        * parse swissprot fields in genpept file 
77        * parse WGS genbank records
79      - embl.pm
80         * Changed regexp for ID line. The capturing parentheses are
81           the same, the difference is an optional repeated-not-semi-
82           colon expression following the captured \S+. This means the
83           regexp works when the division looks like /PRO;/ or when the
84           division looks like /ANG ;/ - the latter is from EMBL
85           repbase
87         * fix ID line parsing: the molecule string can have spaces in
88           it. Like: "genomic DNA"
90      - swiss.pm: bugs  #1727, #1734
91      
92      - entrezgene.pm
93         * Added parser for entrezgene ASN1 (text format) files.
94           Uses Bio::ASN1::EntrezGene as a low level parser (get it from CPAN)
96     o Bio::AlignIO
98      -  maf.pm coordinate problem fixed
99       
100     o Bio::Taxonomy and Bio::DB::Taxonomy
102      - Parse NCBI XML now so that nearly all the taxonomy up-and-down 
103        can be done via Web without downloading all the sequence.
105     o Bio::Tools::Run::RemoteBlast supports more options and complies
106       to changes to the NCBI interface. It is reccomended that you
107       retrieve the data in XML instead of plain-text BLAST report to
108       insure proper parsing and retrieval of all information as NCBI
109       fully expects to change things in the future.
111     o Bio::Tree and Bio::TreeIO
113       - Fixes so that re-rooting a tree works properly
115       - Writing out nhx format from a newick/nexus file will properly output
116         bootstrap information.  The use must move the internal node labels over
117         to bootstraps.
118          for my $node ( grep { ! $_->is_Leaf } $tree->get_nodes ) {
119             $node->bootstrap($node->id);
120             $node->id('');
121          }
122       - Nexus parsing is much more flexible now, does not care about
123         LF.
125       - Cladogram drawing module in Bio::Tree::Draw
126       
127       - Node height and depth now properly calculated
129       - fix tree pruning algorithm so that node with 1 child gets merged
131     o Graphics tweaks.  Glyph::xyplot improved.  Many other small-medium sized
132       bugs and improvements were added, see Gbrowse mailing list for most of 
133       these.
135     o Bio::DB::GFF partially supports GFF3.  See information about 
136       gff3_munge flag in scripts/Bio-DB-GFF/bulk_load_gff.pl.
137          
138     o Better location parsing in Bio::Factory::FTLocationFactory -
139       this is part of the engine for parsing EMBL/GenBank feature table
140       locations.  Nested join/order-by/complement are allowed now
142     o Bio::PrimarySeqI->translate now takes named parameters
144     o Bio::Tools::Phylo::PAML - parsing RST (ancestral sequence
145       reconstruction) is now supported.  Parsing different models and 
146       branch specific parametes are now supported.
148     o Bio::Factory::FTLocationFactory - parse hierarchical locations 
149       (joins of joins)
151     o Bio::Matrix::DistanceMatrix returns arrayrefs instead of arrays
152       for getter/setter functions
154     o Bio::SearchIO
155       
156       - blast bug #1739; match scientific notation in score 
157         and possible e+ values 
159       - blast.pm reads more WU-BLAST parameters and parameters, match
160         a full database pathname, 
161    
162       - Handle NCBI WEB and newer BLAST formats specifically
163         (Query|Sbjct:) match in alignment blocks can now be (Query|Sbjct).
165       - psl off-by-one error fixed
167       - exonerate parsing much improved, CIGAR and VULGAR can be parsed
168         and HSPs can be constructed from them.
170       - HSPs query/hit now have a seqdesc field filled out (this was
171         always available via $hit->description and
172         $result->query_description
174       - hmmer.pm can parse -A0 hmmpfam files
176       - Writer::GbrowseGFF more customizeable.
178     o Bio::Tools::Hmmpfam 
179       make e-value default score displayed in gff, rather than raw score
180       allow parse of multiple records
183 1.5 Developer release
185     o Bio::Align::DNAStatistics and Bio::Align::ProteinStatistics
186       provide Jukes-Cantor and Kimura pairwise distance methods,
187       respectively.
189     o Bio::AlignIO support for "po" format of POA, and "maf";
190       Bio::AlignIO::largemultifasta is a new alternative to
191       Bio::AlignIO::fasta for temporary file-based manipulation of
192       particularly large multiple sequence alignments.
194     o Bio::Assembly::Singlet allows orphan, unassembled sequences to
195       be treated similarly as an assembled contig.
197     o Bio::CodonUsage provides new rare_codon() and probable_codons()
198       methods for identifying particular codons that encode a given
199       amino acid.
201     o Bio::Coordinate::Utils provides new from_align() method to build
202       a Bio::Coordinate pair directly from a
203       Bio::Align::AlignI-conforming object.
205     o Bio::DB::Biblio::eutils is a class for querying NCBI's Eutils.
206       Send a Pubmed, Pubmed Central, Entrez, or other query to NCBI's
207       web service using standard Pubmed query syntax, and retrieve
208       results as XML.
210     o Bio::DB::GFF has various sundry bug fixes.
212     o Bio::FeatureIO is a new SeqIO-style subsystem for
213       writing/reading genomic features to/from files.  I/O classes
214       exist for BED, GTF (aka GFF v2.5), and GFF v3.  Bio::FeatureIO
215       classes only read/write Bio::SeqFeature::Annotated objects.
216       Notably, the GFF v3 class requires features to be typed into the
217       Sequence Ontology.
219     o Bio::Graph namespace contains new modules for manipulation and
220       analysis of protein interaction graphs.
222     o Bio::Graphics has many bug fixes and shiny new glyphs.
224     o Bio::Index::Hmmer and Bio::Index::Qual provide multiple-file
225       indexing for HMMER reports and FASTA qual files, respectively.
227     o Bio::Map::Clone, Bio::Map::Contig, and Bio::Map::FPCMarker are
228       new objects that can be placed within a Bio::Map::MapI-compliant
229       genetic/physical map; Bio::Map::Physical provides a new physical
230       map type; Bio::MapIO::fpc provides finger-printed clone mapping
231       import.
233     o Bio::Matrix::PSM provide new support for postion-specific
234       (scoring) matrices (e.g. profiles, or "possums").
236     o Bio::Ontology::Ontology and Bio::Ontology::Term objects can now
237       be instantiated without explicitly using Bio::OntologyIO.  This
238       is possible through changes to Bio::Ontology::OntologyStore to
239       download ontology files from the web as necessary.  Locations of
240       ontology files are hard-coded into
241       Bio::Ontology::DocumentRegistry.
243     o Bio::PopGen includes many new methods and data types for
244       population genetics analyses.
246     o New constructor to Bio::Range, unions().  Given a list of
247       ranges, returns another list of "flattened" ranges --
248       overlapping ranges are merged into a single range with the
249       mininum and maximum coordinates of the entire overlapping group.
251     o Bio::Root::IO now supports -url, in addition to -file and -fh.
252       The new -url argument allows one to specify the network address
253       of a file for input.  -url currently only works for GET
254       requests, and thus is read-only.
256     o Bio::SearchIO::hmmer now returns individual Hit objects for each
257       domain alignment (thus containing only one HSP); previously
258       separate alignments would be merged into one hit if the domain
259       involved in the alignments was the same, but this only worked
260       when the repeated domain occured without interruption by any
261       other domain, leading to a confusing mixture of Hit and HSP
262       objects.
264     o Bio::Search::Result::ResultI-compliant report objects now
265       implement the "get_statistics" method to access
266       Bio::Search::StatisticsI objects that encapsulate any
267       statistical parameters associated with the search (e.g. Karlin's
268       lambda for BLAST/FASTA).
270     o Bio::Seq::LargeLocatableSeq combines the functionality already
271       found in Bio::Seq::LargeSeq and Bio::LocatableSeq.
273     o Bio::SeqFeature::Annotated is a replacement for
274       Bio::SeqFeature::Generic.  It breaks compliance with the
275       Bio::SeqFeatureI interface because the author was sick of
276       dealing with untyped annotation tags.  All
277       Bio::SeqFeature::Annotated annotations are Bio::AnnotationI
278       compliant, and accessible through Bio::Annotation::Collection.
280     o Bio::SeqFeature::Primer implements a Tm() method for primer
281       melting point predictions.
283     o Bio::SeqIO now supports AGAVE, BSML (via SAX), CHAOS-XML,
284       InterProScan-XML, TIGR-XML, and NCBI TinySeq formats.
286     o Bio::Taxonomy::Node now implements the methods necessary for
287       Bio::Species interoperability.
289     o Bio::Tools::CodonTable has new reverse_translate_all() and
290       make_iupac_string() methods.
292     o Bio::Tools::dpAlign now provides sequence profile alignments.
294     o Bio::Tools::GFF now parses GFF version 2.5 (a.k.a. GTF).
296     o Bio::Tools::Fgenesh, Bio::Tools::tRNAscanSE are new report
297       parsers.
299     o Bio::Tools::SiRNA includes two new rulesets (Saigo and Tuschl)
300       for designing small inhibitory RNA.
302     o Bio::Tree::DistanceFactory provides NJ and UPGMA tree-building
303       methods based on a distance matrix.
305     o Bio::Tree::Statistics provides an assess_bootstrap() method to
306       calculate bootstrap support values on a guide tree topology,
307       based on provided bootstrap tree topologies.
308   
309     o Bio::TreeIO now supports the Pagel (PAG) tree format.
310   
311 1.4 branch
313 1.4.1 
315   o Improvements to Bio::AlignIO::nexus for parsing TreeBase nexus files
316   
317   o Bio::Graphics will work with gd1 or gd2
318    
319   o Bio::SearchIO
320    - hmmer.pm Better hmmpfam parsing, fix bug for small number of alignment outputs
321      (RF lines alone)
322    - blast.pm Parse multi-line query fields properly
323    - small speed improvements to blasttable.pm and others
325   o Bio::DB::Taxonomy has better support for hierarchy traversal so that
326     Bio::Taxonomy::Node can be as simple as Bio::Species object while still
327     supporting more complex queries
330 1.4. Stable major release
332 Since initial 1.2.0, 3000 separate changes have been made to make this release. 
334    o installable scripts
336    o global module version from Bio::Root:Version
338    o Bio::Graphics
339       - major improvements; SVG support
341    o Bio::Popgen
342      - population genetics 
343      - support several population genetics types of questions.
344      - Tests for statistical neutrality of mutations
345        (Fu and Li's D/F, Tajima's D) are in Bio::PopGen::Statistics.
346        Tests of population structure (Wright's F-statistic: Fst) is in
347        Bio::PopGen::PopStats. Calculating composite linkage
348        disequilibrium (LD) is available in Bio::PopGen::Statistics as
349        well.
350      - Bio::PopGen::IO for reading in prettybase (SeattleSNPs)
351        and csv (comma delimited formatted) data.
353      - a directory for implementing population simulations has
354        been added Bio::PopGen::Simulation and 2 simulations - a
355        Coalescent and a simple single-locus multi-allele genetic drift
356        simulation have been provided.  This replaces the code in
357        Bio::Tree::RandomTree which has been deprecated until proper
358        methods for generating random phylogenetic trees are
359        implemented.
361    o Bio::Restriction
362       - new restrion analysis modules
364    o Bio::Tools::Analysis
365       - web based DNA and Protein analysis framework and several
366         implementations
368    o Bio::Seq::Meta
369      - per residue annotable sequences
371    o Bio::Matrix
372       - Bio::Matrix::PSM - Position Scoring Matrix
373       - Bio::Matrix::IO has been added for generalized parsing of
374         matrix data.  Matrix::IO::scoring and Matrix::IO::phylip are
375         initial implementations for parsing BLOSUM/PAM and Phylip
376         Distance matricies respectively.  A generic matrix
377         implementation for general use was added in
378         Bio::Matrix::Generic.
380    o Bio::Ontology
381      - major changes
383    o Bio:Tree
385    o Bio::Tools::SiRNA, Bio::SeqFeature::SiRNA
386      - small inhibitory RNA
388    o Bio::SeqFeature::Tools
389      - seqFeature mapping tools
390      - Bio::SeqFeature::Tools::Unflattener.pm
391        -- deal with mapping GenBank feature collections into
392           Chado/GFF3 processable feature sets (with SO term mappings)
394    o Bio::Tools::dpAlign
395      - pure perl dynamic programming sequence alignment
396      - needs Bioperl-ext
398    o new Bio::SearchIO formats
399      - axt and psl:  UCSC formats.
400      - blasttable: NCBI -m 8 or -m 9 format from blastall
402    o new Bio::SeqIO formats
403      - chado, tab, kegg, tigr, game
404      - important fixes for old modules
406    o Bio::AlignIO: maf
408    o improved Bio::Tools::Genewise
410    o Bio::SeqIO now can recongnize sequence formats automatically from
411      stream
413    o new parsers in Bio::Tools:
414       Blat, Geneid, Lagan, Mdust, Promoterwise, PrositeScan,  
416    o Bio::DB::Registry bugs fixed
417      - BerkeleyDB-indexed flat files can be used by the OBDA system
418      - Multiple seqdatabase.ini locations in OBDA_SEARCH_PATH are all
419        used by the OBDA system
421    o several new HOWTOs
422      - SimpleWebAnalysis, Trees, Feature Annotation, OBDA Access, Flat
423        Databases
425    o hundreds of new and improved files 
428    o 
429    o Bio::Tree::AlleleNode has been updated to be a container of
430      an Bio::PopGen::Individual object for use in the Coalescent simulations.
433 1.2 Branch
435 1.2.3 Stable release update
436     o Bug #1475 - Fix and add speedup to spliced_seq for remote location
437                   handling.
438     o Bug #1477 - Sel --> Sec abbreviation fixed
439     o Fix bug #1487 where paring in-between locations when 
440       end < start caused the FTLocationFactory logic to fail.
441     o Fix bug #1489 which was not dealing with keywords as an
442       arrayref properly (this is fixed on the main trunk because
443       keywords returns a string and the array is accessible via
444       get_keywords).
445     o Bio::Tree::Tree memory leak (bug #1480) fixed
446       Added a new initialization option -nodelete which
447       won't try and cleanup the containing nodes if this
448       is true.
449      o Bug with parsing labeled nodes with Bio::TreeIO::newick fixed
450        this was only present on the branch for the 1.2.1 and 1.2.2 series
451        - Also merged main trunk changes to the branch which make
452          newick -> nhx round tripping more effective (storing branch length
453          and bootstrap values in same locate for NodeNHX and Node 
454          implementations.)  Fixes to TreeIO parsing for labeled internal
455          also required small changes to TreeIO::nhx.  Improved
456          tests for this module as well.
457     o Bio::SearchIO
458       - Fixed bugs in BLAST parsing which couldn't parse NCBI
459         gapped blast properly (was losing hit significance values due to
460         the extra unexpeted column).    
461       - Parsing of blastcl3 (netblast from NCBI) now can handle case of
462         integer overflow (# of letters in nt seq dbs is > MAX_INT)
463         although doesn't try to correct it - will get the negative
464         number for you.  Added a test for this as well.
465       - Fixed HMMER parsing bug which prevented parsing when a hmmpfam report
466         has no top-level family classification scores but does have scores and
467         alignments for individual domains.
468       - Parsing FASTA reports where ungapped percent ID is < 10 and the 
469         regular expression to match the line was missing the possibility of
470         an extra space.  This is rare, which is why we probably did not 
471         catch it before.
472       - BLAST parsing picks up more of the statistics/parameter fields
473         at the bottom of reports.  Still not fully complete.
474       - SearchIO::Writer::HTMLResultWriter and TextResultWriter
475         were fixed to include many improvements and added flexiblity
476         in outputting the files.  Bug #1495 was also fixed in the process.
477      o Bio::DB::GFF
478       - Update for GFF3 compatibility.
479       - Added scripts for importing from UCSC and GenBank.
480       - Added a 1.2003 version number.
481      o Bio::Graphics
482       - Updated tutorial.
483       - Added a 1.2003 version number.
484      o SeqIO::swiss Bug #1504 fixed with swiss writing which was not
485        properly writing keywords out.
486      o Bio::SeqIO::genbank 
487       - Fixed bug/enhancement #1513 where dates of
488         the form D-MMM-YYYY were not parsed.  Even though this is
489         invalid format we can handle it - and also cleanup the date
490         string so it is properly formatted.
491       - Bug/enhancement #1517 fixed so that SEGMENT line can be parsed 
492         and written with Genbank format.  Similarly bug #1515 is fixed to
493         parse in the ORIGIN text.
494      o Bio::SeqIO::fasta, a new method called preferred_id_type allows you
495        to specify the ID type, one of (accession accession.version 
496        display primary).  See Bio::SeqIO::preferred_id_type method
497        documentation for more information.
498      o Unigene parsing updated to handle file format changes by NCBI
500 1.2.2 Stable release update
502     o A series of bug fixes of the Bio::OntologyIO dagflat-related parsers:
503       - auto-discover ontology name
504       - bug in parsing relationships when certain characters are in the term
505       - fixed hard-coded prefix for term identifiers
506       - various smaller issues 
508     o Fixed bug in Bio::Annotation::OntologyTerm of not implementing all
509       of Bio::Ontology::TermI
511     o brought the OBDA Registry code up to latest specs 
513     o Bio::DB::GenBank
514       - eutils URL change
515       - accession number retrieval fixed
517     o Bio::SearchIO::blast - fix bug #1443 (missing last hits), parse megablast
519     o Bio::SearchIO::Writer::(HTML|Text)ResultWriter fix bugs #1458, 
520       #1459 which now properly report alignment start/end info
521       for translated BLAST/FASTA searches.
522     
523     o Bio::TreeIO::newick can parse labeled internal nodes
525     o Bio::Tools::BPbl2seq can properly report strand info for HSPs 
526       for BLASTX if if you provide -report_type => 'BLASTX' when
527       initializing a BPbl2seq object.  Bioperl 1.3 will have better
528       support for bl2seq in the SearchIO system.
530     o Bio::Root::IO support a -noclose boolean flag which will not
531       close a filehandle upon object cleanup - useful when sharing
532       a filehandle among objects.  Additionally code added s.t.
533       STDOUT/STDIN/STDERR will never be closed by Root::IO cleanup.
535     o Bio::Tools::Genemark bug #1435 fixed which was missing last prediction
537     o Bio::SeqIO::genbank 
538       - bug #1456 fixed which generated extra sequence lines
539       - write moltype correctly for genpept
541 1.2.1 Stable release update
543     o Inclusion of WrapperBase, a needed component for StandAloneBlast
545     o Addition from main trunk of Ontology objects, principly to allow
546       BioSQL releases against 1.2.1
548     o Fixes and cleanup of Bio::Coordinate modules
550     o A fix to Bio::Index::EMBL allowing  retrieval of entries using
551       the primary accession number
553     o Other bug fixes, including bpindex GenBank fix
554    
555     o Bio::SeqIO::genbank bug #1389 fixed
557 1.2  Stable major release
559     o More functionality added to Bio::Perl, the newbie module
561     o Bug fixes in Bio::TreeIO::newick fixes bug introduced in 1.0.2
562       Support for New Hampshire Extended (NHX) format parsing.
564     o Bio::Tools added support for parsing Genomewise, Pseudowise, Est2Genome,
565       Tmhmm, SignalP, Seg, RepeatMasker, FootPrinter, and a lightweight
566       Hmmpfam parser.
568     o New ontology parsing Bio::Ontology
570     o Bug fixes in Bio::SearchIO for HMMer parsing, support for
571       multi-report (mlib) fasta reports, support for waba and exonerate.
573     o Bio::ClusterIO for parsing Unigene clusters
575     o Bio::Assembly added for representing phrap and ace assembly clusters.
577     o Rudimentary support for writing Chado XML (see 
578       GMOD project: www.gmod.org for more information) 
580     o Bio::Coordinate for mapping between different coordinate systems such 
581       as protein -> cDNA -> Exon -> DNA and back.  Useful for mapping
582       features into different coordinate systems.  
584     o Bio::DB::GenBank/Bio::DB::GenPept now support Entrez queries
585       with the get_Stream_by_query method and supports the latest
586       NCBI eutils interface.
588     o Bugs fixed in Bio::SeqFeature::Collection an in-memory fast
589       object for extracting subsets of features : currently only
590       supports extraction by location.
592 1.1.1 Developer release
594     o Deprecated modules are now listed in the DEPRECATED file
596     o New HowTo documents located in doc/howto describing 
597       a domain of Bioperl.
599     o Note that bugs are now stored at bugzilla.bioperl.org
600       and all old bugs are searchable through the bugzilla interface.
602     o Several reported bugs in Bio::Tools::Sigcleave and Bio::SimpleAlign 
603       have been addressed.
605     o Support for Genewise parsing in Bio::Tools::Genewise
607     o Start of Ontology framework with Bio::Ontology
609     o Speedup to the Bio::Root::Root object method _rearrange.
610       A global _load_module method was implemented to simplify the
611       dynamic loading of modules ala Bio::SeqIO::genbank.  This
612       method is now used by all the XXIO (AlignIO,TreeIO,SearchIO,SeqIO,
613       etc).
615     o Several performance improvements to sequence parsing in Bio::SeqIO.
616       Attempt to speedup by reducing object creation overhead.
618     o Bio::DB::GenBank and Bio::DB::GenPept use the NCBI's approved
619       method for sequence retrieval with their E-utils CGI scripts.
620       More work to support Entrez queries to their fullest is planned
621       before 1.2 release.
623     o Numerous fixes to Bio::SearchIO and sequence parsing (swissprot)
625 1.1 Developer release 
627     o Bio::Tools::Run has been broken off into a new pkg bioperl-run,
628       this separation removes some of the complexity in our test suite
629       and separates the core modules in bioperl from those that need
630       external programs to run.
632     o With latest ExtUtils::MakeMaker module installed SGI/IRIX should
633       not run into trouble running the makefile
635     o Bio::Location and Bio::SeqIO::FTHelper are fixed to properly 
636       read,create,and write locations for grouped/split locations
637       (like mRNA features on genomic sequence).  
639     o Bio::Tools::Phlyo added for wrappers for parsing Molphy (protml)
640       and PAML (codeml,aaml, etc) parsing.
642     o Bio::Tree:: objects expanded to handle testing monophyly,
643       paraphyly, least common ancestor, etc.
645     o Bio::Coordinate for mapping locations from different coordinate spaces 
647     o Bio::SearchIO::waba added for parsing WABA, Bio::SearchIO::hmmer
648       added for parsing hmmpfam and hmmsearch output.
650     o Bio::SearchIO::Writer::TextResultWriter for outputting
651       a pseudo-blast textfile format
654 1.0.2 Bug fix release
656     o Note: The modules Bio::DB::GenBank and Bio::DB::GenPept provided
657       in this release will not work after December 2002 when NCBI
658       shuts off the old Entrez cgi scripts.  We have already fixed
659       on our main development branch and the functionality will be
660       available in the next stable bioperl release (1.2) slated for
661       Fall 2002.
663     o Numerous parsing bugs in Bio::SearchIO::fasta found through 
664       testset by Robin Emig.  These were fixed as was the get_aln
665       method in Bio::Search::HSP::GenericHSP to handle the extra 
666       context sequence that is provided with a FastA alignment.
667     
668     o Migrating differences between Bio::Search::XX::BlastXX to 
669       Bio::Search::XX::GenericXX objects.  This included mechanism
670       to retrieve whole list of HSPs from Hits and whole list of Hits from 
671       Results in addition to the current next_XX iterator methods that
672       are available.  Added seq_inds() method to GenericHSP which identifies
673       indexes in the query or hit sequences where conserved,identical,gaps, 
674       or mismatch residues are located (adapted from Steve Chervitz's 
675       implementation in BlastHSP).
677     o Bio::DB::GFF bugs fixed and are necessary for latest GBrowse release.
678       Bio::DB::GFF::RelSegment is now Bio::SeqI compliant.
679       
680     o Bio::Graphics glyph set improved and extended for GBrowse release
682     o Bio::Tree::Tree get_nodes implementation improvement thanks
683       to Howard Ross notice performance problem when writing out 
684       unbalanced trees.
686     o Bio::Location::Fuzzy::new named parameter -loc_type became
687       -location_type, Bio::Location::Simple::new named parameter
688       -seqid becamse -seq_id.
689    
690     o Fixed major Bio::AlignIO::emboss parsing bug on needle output,
691       was mis-detecting that gaps should be placed at the beginning of
692       the alignment when the best alignment starts internally in the
693       sequence.
695 1.0.1 Bug fix release
696         
697     o Minor bug fixes to Bio::DB:GFF.  Glyph sets improved.
699     o Parser fixes in SearchIO blast, fasta for more complete WU BLAST 
700       and mixed (3.3 - 3.4) versions of FASTA.
702     o Small API change to add methods for completeness across 
703       implementations of Bio::Search objects.  These new methods
704       in the interface are implemented by the GenericXX object as well  
705       as the BlastXX objects.
706         * Bio::Search::Result::ResultI 
707          - hits() method returns list of all Hits (next_hit is an 
708            iterator method)
709                 
710         * Bio::Search::Hit::HitI
711          - hsps() method returns list of all HSPs (next_hsp is an 
712            iterator method)
713         
714     o The Bio::SearchIO::Writer classes have been fixed to handle results 
715        created from either psiblast (Search::BlastXX objects) or 
716        blast|fasta|blastxml objects (Search::GenericXX objects).  More work 
717        has to be done here to make it work properly and will nee major 
718        API changes.
720     o Bugs in Bio::Tools::HMMER fixed, including
721        * #1178 - Root::IO destructor wasn't being called
722        * #1034 - filter_on_cutoff now behaves properly
724     o Bio::SeqFeature::Computation initialization args fixed and 
725       tests added.
727     o Tests are somewhat cleaner, flat.t now properly cleans up after itsself,
728       
729     o Updated FAQ with more example based answers to typical questions
731     o Bug #1202 was fixed which would improperly join together qual values
732       parsed by Bio::SeqIO::qual when a trailing space was not present before
733       the newline.
735 1.0.0 Major Stable Release
737   This represents a major release of bioperl with significant
738   improvements over the 0.7.x series of releases.   
740     o Bio::Tools::Blast is officially deprecated.  Please see
741       Bio::SearchIO for BLAST and FastA parsing.
743     o The methods trunc() and subseq() in Bio::PrimarySeqI now accepts
744       Bio::LocationI objects as well as start/end.
746     o Bio::Biblio contains modules for Bibliographic data. 
747       Bio::DB::Biblio contains the query modules.  Additionally one can
748       parse medlinexml from the ebi bibliographic query service (BQS)
749       system and Pubmed xml from NCBI.  See Martin Senger's
750       documentation in Bio::Biblio for more information.
751     
752     o Bio::DB::Registry is a sequence database registry part of 
753       Open Bioinformatics Database Access.  See
754       http://obda.open-bio.org for more information.
755     
756     o File-based and In-Memory Sequence caching is provided by
757       Bio::DB::InMemoryCache and Bio::DB::FileCache which acts like a
758       local database.
760     o Bio::Graphics for rendering sequences as PNG,JPG, or GIFs has
761       been added by Lincoln Stein.
763     o XEMBL SOAP service access in provided in Bio::DB::XEMBL.
765     o A FAQ has been started and is included in the release to provide
766       a starting point for frequent questions and issues.
768 0.9.3 Developer's release
769     
770     o Event based parsing system improved (SearchIO).  With parsers for
771       XML Blast (blastxml), Text Blast (blast), and FASTA results (fasta).  
772       Additionally a lazy parsing system for text and html blast reports was
773       added and is called psiblast (name subject to change in future releases).
775     o Bio::Search objects improved and standardized with associated Interfaces
776       written.  The concept of a search "Hit" was standardized to be called
777       "hit" consistently and the use of "subject" was deprecated in all active
778       modules.
780     o Bio::Structure added (since 0.9.1) for Protein structure objects 
781       and PDB parser to retrieve and write these structures from data files. 
783     o Several important Bio::DB::GFF bug fixes for handling features that
784       are mapped to multiple reference points.  Updated mysql adaptor
785       so as to be able to store large (>100 megabase) chunks of DNA into
786       Bio::DB::GFF databases.
788 0.9.2 Developer's release
790     o Bio::Search and Bio::SearchIO system introduced for event based
791       parsing of Blast,Fasta reports Bio::SearchIO supports ncbi BLAST
792       in text and XML and FASTA reports in standard output format.
794     o Bio::Tree and Bio::TreeIO for phylogenetic trees.  A Random tree
795       generator is included in Bio::TreeIO::RandomTrees and a
796       statistics module for evaluating.
797       
798     o Bio::DB::GFF, Lincoln Stein's GFF database suitable as a DB
799       server for DAS servers.
801     o Bio::Tools::BPlite is provides more robust parsing of BLAST
802       files.  The entire BPlite system migrated to using Bio::Root::IO
803       for the data stream.
804         
805     o Bio::Tools::Alignment for Consed and sequence Trimming
806       functionality.
808     o Bio::Structure for Protein structure information and parsing
810     o Bio::DB::GenBank/Bio::DB::GenPept updated to new NCBI Entrez
811       cgi-bin entry point which should be more reliable.
812    
813     o Bio::Map and Bio::MapIO for biological map navigation and a
814       framework afor parsing them in.  Only preliminary work here.
816     o Interface for executing EMBOSS programs locally in Bio::Factory::EMBOSS
817       Future work will integrate Pise and allow submission of analysis on
818       remote servers.
820     o Bio::AnnotationCollectionI and Bio::Annotation::Collection
821       introduced as new objects for handling Sequence Annotation
822       information (dblinks, references, etc) and is more robust that
823       previous system.
825     o Bio::Tools::FASTAParser introduced.
827     o Scripts from the bioperl script submission project and new
828       scripts from bioperl authors are included in "scripts" directory.
830     o Factory objects and interfaces are being introduced and are more
831       strictly enforced.
832         
833     o Bio::Root::Root introduced as the base object while
834       Bio::Root::RootI is now simply an interface.
836     o Bio::DB::RefSeq provides database access to copy of the NCBI
837       RefSeq database using the EBI dbfetch script.
839 0.9.0 Developer's release
841     o perl version at least 5.005 is now required instead of perl 5.004
843     o Bio::Tools::Run::RemoteBlast is available for running remote 
844       blast jobs at NCBI.
846     o Bio::Tools::BPbl2seq was fixed to handle multiple HSPs.
848     o Bio::SeqFeature::GeneStructure migrated to Bio::SeqFeature::Gene.
849       Also added are related modules UTR3, UTR5, Exon, Intron, 
850       Promotor, PolyA and Transcript.
852     o Speedup of translate method in PrimarySeq     
854     o Bio::SimpleAlign has new methods: location_from_column(), slice(),
855       select(), dot(), get_seq_by_pos(), column_from_residue_number()
857     o Various fixes to Variation toolkit
858     
859     o Bio::DB::EMBL provides database access to EMBL sequence data.
860       Bio::DB::Universal provides a central way to point to indexes
861       and dbs in a single interface.
863     o Bio::DB::GFF - a database suitable for running DAS servers locally.
865     o Bio::Factory::EMBOSS is still in design phase as is  
866       Bio::Factory::ApplicationFactoryI
868     o Dia models for bioperl design are provided in the models/ directory
870 0.7.2 Bug fix release
872     o documentation fixes in many modules - SYNOPSIS code verified 
873       to be runnable in many (but not all modules)
875     o corrected MANIFEST file from 0.7.1 release
876    
877     o Bug fix in Bio::SeqIO::FTHelper to properly handle
878       split locations
880     o Bio::SeqIO::genbank 
881         * Correct parsing and writing of genbank format with protein data
882         * moltype and molecule separation                          
884     o Bio::SeqIO::largefasta fix to avoid inifinite loops
885         
886     o Bio::SimpleAlign fixed to correctly handle consensus 
887       sequence calculation
889     o Bio::Tools::HMMER supports hmmer 2.2g
891     o Bio::Tools::BPlite to support report type specific parsing.  Most 
892       major changes are not on the 0.7 branch.
893    
894     o Bio::Tools::Run::StandAloneBlast exists_blast() fixed and works 
895       with File::Spec 
897     o Bio::Variation::AAChange/RNAChange corrected labels and mutated alleles 
898         in several types of mutations:
899         1.) AA level: deletion, complex
900         2.) AA level: complex, inframe
901         3.) RNA level: silent
903     o  BPbl2seq parsing of empty reports will not die, but will return
904        a valid, empty, Bio::SeqFeature::SimilarityFeature for
905        $report->query() and $report->subject() methods.  So an easy
906        way to test if report was empty is to see if
907        $report->query->seqname is undefined.
909 0.7.1 Bug fix release 
911     o Better parsing of genbank/EMBL files especially fixing bugs
912       related to Feature table parsing and locations on remote
913       sequences.  Additionally, species name parsing was better.
915     o Bio::SeqIO::genbank can parse now NCBI produced genbank database
916       which include a number of header lines.
918     o More strict genbank and EMBL format writing (corrected number of
919       spaces where appropriate).
921     o Bio::Tools::BPlite can better parse BLASTX reports - see BUGS
922       for related BPlite BUGS that are unresolved in this release.
923   
924     o Bio::DB::GenBank, Bio::DB::GenPept have less problems
925       downloading sequences from NCBI via HTTP.  Bio::DB::SwissProt can
926       use expasy mirrors or EBI dbfetch cgi-script.
928     o A moderate number of documentation improvements were made as
929       well to provide a better code synopsis in each module.
932 0.7  Large number of changes, including refactoring of the
933      Object system, new parsers, new functionality and
934      all round better system. Highlights are:
937      o Refactored root of inheritance: moved to a lightweight Bio::Root::RootI;
938        Bio::Root::IO for I/O and file/handle capabilities.
940      o Imported BPlite modules from Ian Korf for BLAST
941        parsing. This is considered the supported BLAST parser;
942        Bio::Tools::Blast.pm will eventually phase out due to lack of support.
944      o Improved Sequence Feature model. Added complete location
945        modelling (with fuzzy and compound locations).  See
946        Bio::LocationI and the modules under Bio/Location.  Added
947        support in Genbank/EMBL format parsing to completely parse
948        feature tables for complex locations.
950      o Moved special support for databanks etc to specialized modules under
951        Bio/Seq/. One of these supports very large sequences through 
952        a temporary file as a backend.
954      o Explicit Gene, Transcript and Exon SeqFeature objects, supporting
955        CDS retrieval and exon shuffling.
957      o More parsers: Sim4, Genscan, MZEF, ESTScan, BPbl2seq, GFF
959      o Refactored Bio/DB/GenBank+GenPept. There is now also DB/SwissProt and
960        DB/GDB (the latter has platform-specific limitations).
962      o New analysis parser framework for HT sequence annotation (see
963        Bio::SeqAnalysisParserI and Bio::Factory::SeqAnalysisParserFactory)
965      o New Alignment IO framework
967      o New Index modules (Swissprot)
969      o New modules for running Blast within perl
970        (Bio::Tools::Run::StandAloneBlast). Added modules for running
971        Multiple Sequence Alignment tools ClustalW and TCoffee
972        (Bio::Tools::Run::Alignment).
974      o New Cookbook-style tutorial (see bptutorial.pl). Improved
975        documentation across the package.
977      o Much improved cross platform support. Many known incompatibilities
978        have been fixed; however, NT and Mac do not work across the entire
979        setup (see PLATFORMS).
981      o Many bug fixes, code restructuring, etc. Overall stability and
982        maintainability benefit a lot.
984      o A total of 957 automatic tests
985     
987 0.6.2  
989    There are very few functionality changes but a large
990    number of software improvements/bug fixes across the package.
992    o The EMBL/GenBank parsing are improved.
994    o The Swissprot reading is improved. Swissprot writing
995      is disabled as it doesn't work at all. This needs to
996      wait for 0.7 release
998    o BLAST reports with no hits are correctly parsed.
1000    o Several other bugs of the BLAST parser (regular expressions, ...)
1001      fixed.
1003    o Old syntax calls have been replaced with more modern syntax
1005    o Modules that did not work at all, in particular the Sim4
1006      set have been removed
1008    o Bio::SeqFeature::Generic and Bio::SeqFeature::FeaturePair
1009      have improved compliance with interface specs and documentation
1011    o Mailing list documentation updated throughout the distribution
1013    o Most minor bug fixes have happened.
1015    o The scripts in /examples now work and have the modern syntax
1016      rather than the deprecated syntax
1019 0.6.1  Sun April 2 2000
1021    o Sequences can have Sequence Features attached to them
1022         - The sequence features can be read from or written to
1023           EMBL and GenBank style flat files
1025    o Objects for Annotation, including References (but not
1026      full medline abstracts), Database links and Comments are
1027      provided
1029    o A Species object to represent nodes on a taxonomy tree
1030      is provided
1032    o The ability to parse HMMER and Sim4 output has been added
1034    o The Blast parsing has been improved, with better PSI-BLAST
1035      support and better overall behaviour.
1037    o Flat file indexed databases provide both random access 
1038      and sequential access to their component sequences.
1040    o A CodonTable object has been written with all known 
1041      CodonTables accessible.
1043    o A number of new lightweight analysis tools have been
1044      added, such as molecular weight determination.
1046     The 0.6 release also has improved software engineering
1047   
1048    o The sequence objects have been rewritten, providing more
1049      maintainable and easier to implement objects. These
1050      objects are backwardly compatible with the 0.05.1 objects
1052    o Many objects are defined in terms of interfaces and then  
1053      a Perl implementation has been provided. The interfaces
1054      are found in the 'I' files (module names ending in 'I').
1056      This means that it is possible to wrap C/CORBA/SQL access
1057      as true "bioperl" objects, compatible with the rest of
1058      bioperl.
1060    o The SeqIO system has been overhauled to provide better
1061      processing and perl-like automatic interpretation of <>
1062      over arguments.
1064    o Many more tests have been added (a total of 172 automatic
1065      tests are now run before release).
1069 0.05.1 Tue Jun 29 05:30:44 1999
1070         - Central distribution now requires Perl 5.004. This was
1071           done to get around 5.003-based problems in Bio/Index/* 
1072           and SimpleAlign.
1073         - Various bug fixes in the Bio::Tools::Blast modules
1074           including better exception handling and PSI-Blast 
1075           support. See Bio/Tools/Blast/CHANGES for more.
1076         - Fixed the Parse mechanism in Seq.pm to use readseq.
1077           Follow the instructions in README for how to install
1078           it (basically, you have to edit Parse.pm).
1079         - Improved documentation of Seq.pm, indicating where 
1080           objects are returned and where strings are returned.
1081         - Fixed uninitialized warnings in Bio::Root::Object.pm
1082           and Bio::Tools::SeqPattern.pm.
1083         - Bug fixes for PR#s: 30,31,33-35,41,42,44,45,47-50,52.
1085 0.05  Sun Apr 25 01:14:11 1999
1086         - Bio::Tools::Blast modules have less memory problems
1087           and faster parsing. Webblast uses LWP and supports
1088           more functionality. See Bio/Tools/Blast/CHANGES for more.
1089         - The Bio::SeqIO system has been started, moving the
1090           sequence reformatting code out of the sequence object
1091         - The Bio::Index:: system has been started, providing
1092           generic index capabilities and specifically works for
1093           Fasta formatted databases and EMBL .dat formatted 
1094           databases
1095         - The Bio::DB:: system started, providing access to 
1096           databases, both via flat file + index (see above) and
1097           via http to NCBI
1098         - The scripts/ directory, where industrial strength scripts
1099           are put has been started.
1100         - Many changes - a better distribution all round.
1102 0.04.4  Wed Feb 17 02:20:13 1999
1103         - Bug fixes in the Bio::Tools::Blast modules and postclient.pl
1104           (see Bio::Tools::Blast::CHANGES).
1105         - Fixed a bug in Bio::Tools::Fasta::num_seqs().
1106         - Beefed up the t/Fasta.t test script.
1107         - Small fix in Bio::Seq::type() (now always returns a string).
1108         - Changed Bio::Root::Utilities::get_newline_char() to 
1109           get_newline() since it could return more than one char.
1110         - Added $NEWLINE and $TIMEOUT_SECS to Bio::Root::Global.
1111         - Changed default timeout to 20 seconds (was 3).
1112         - Moved lengthy modification notes to the bottom of some files.
1113         - Fixed SimpleAlign write_fasta bug.
1114         - Beefed up SimpleAlign.t test
1116 0.04.3  Thu Feb  4 07:48:53 1999
1117         - Bio::Root::Object.pm and Global.pm now detect when
1118           script is run as a CGI and suppress output that is only
1119           appropriate when running interactively.
1120         - Bio::Root::Err::_set_context() adds name of script ($0).
1121         - Added comments in Bio::Tools::WWW.pm and Bio::Root::Utilities.pm
1122           regarding the use of the static objects via the qw(:obj) tag.
1123         - Fixed the ambiguous reverse calls in Seq.pm and UnivAln.pm to 
1124           CORE::reverse, avoiding Perl warnings.
1125         - Bug fixes in Bio::Tools::Blast modules (version 0.074) and 
1126           example scripts (see Bio::Tools::Blast::CHANGES).
1127         - examples/seq/seqtools.pl no longer always warns about using 
1128           -prot or -nucl command-line arguments; only when using the 
1129           -debug argument.
1130         - Methods added to Bio::Root::Utilities: create_filehandle(), 
1131           get_newline_char(), and taste_file() to generalize filehandle 
1132           creation and autodetect newline characters in files/streams
1133           (see bug report #19).
1134         - Bio::Root::IOManager::read() now handles timeouts and uses
1135           Utilities::create_filehandle().
1136         - Bio::Tools::Fasta.pm uses Utilities::get_newline_char() instead
1137           of hardwiring in "\n".
1138         - Bug fixes in the Bio::SimpleAlign and Bio::Tools::pSW
1140 0.04.2  Wed Dec 30 02:27:36 1998
1141         - Bug fixes in Bio::Tools::Blast modules, version 0.073
1142           (see Bio::Tools::Blast::CHANGES).
1143         - Changed reverse calls in Bio/Seq.pm and Bio/UnivAln.pm
1144           to CORE::reverse (prevents ambiguous warnings with 5.005).
1145         - Appending '.tmp.bioperl' to temporary files created by
1146           Bio::Root::Utilities::compress() or uncompress() to
1147           make it easy to identify & cleanup these files as needed.
1148         - Developers: Created CVS branch release-0-04-bug from
1149           release-0-04-1. Before making bug fixes to the 0.04.1 release,
1150           be sure to cvs checkout this branch into a clean area.
1152 0.04.1  Wed Dec 16 05:39:15 1998
1153         - Bug fixes in Bio::Tools::Blast modules, version 0.072
1154           (see Bio::Tools::Blast::CHANGES).
1155         - Compile/SW/Makefile.PL now removes *.o and *.a files 
1156           with make clean.
1158 0.04  Tue Dec  8 07:49:19 1998
1159         - Lots of new modules added including:
1160            * Ewan Birney's Bio::SimpleAlign.pm, Bio::Tools::AlignFactory.pm,
1161              and Bio/Compile directory containing XS-linked C code for
1162              creating Smith-Waterman sequence alignments from within Perl.
1163            * Steve Chervitz's Blast distribution has been incorporated.
1164            * Georg Fuellen's Bio::UnivAln.pm for multiple alignment objects.
1165         - Bio/examples directory for demo scripts for all included modules.
1166         - Bio/t directory containing test suit for all included modules.
1167         - For changes specific to the Blast-related modules prior to
1168           incorporation in this central distribution, see the CHANGES
1169           file in the Bio/Tools/Blast directory.
1170      
1171 0.01  Tue Sep  8 14:23:22 1998
1172         - original version from central CVS tree; created by h2xs 1.18