clean up last commit a little
[bioperl-live.git] / Changes
blob292e4f145bd2a7237bcdf060343d095dd64c183f
1 ---------------------------------------------------------
2 Revision history for BioPerl core modules
3 ---------------------------------------------------------
4 The comprehensive history and ongoing development of BioPerl:
6    http://github.com/bioperl/bioperl-live
8 Some of that history is also highlighted on our wiki:
10    http://www.bioperl.org/wiki/Change_log
11    http://www.bioperl.org/wiki/History_of_BioPerl
13 Bugs and requested features list:
15    https://redmine.open-bio.org/projects/bioperl
17 CPAN releases are branched from 'master'.
18 ---------------------------------------------------------
20 1.?.?
22     [New features]
24     * Bio::Seq::SimulatedRead
25         - New module to represent reads taken from other sequences [fangly]
26     * Bio::Root::Root
27         - Support of Clone::Fast as a faster cloning alternative [fangly]
28     * Bio::Root::IO
29         - Moved the format() and variant() methods from Bio::*IO modules to
30           Bio::Root::IO [fangly]
31         - Can now use format() to get the type of IO format in use [fangly]
32     * Bio::Tools::IUPAC
33         - New regexp() method to create regular expressions from IUPAC sequences
34           [fangly]
35     * Bio::SeqFeature::Primer and Bio::Seq::PrimedSeq:
36         - Code refresh [fangly]
37     * Bio::DB::Taxonomy
38         - Added support for the Greengenes and Silva taxonomies [fangly]
39     * Bio::Tree::TreeFunctionsI
40         - get_lineage_string() represents a lineage as a string [fangly]
41         - add_trait() returns instead of reporting an error when the column
42           number is exceeded in add_trait() [fangly]
43         - Option to support tree leaves without trait [fangly]
44         - Allow ID of 0 in trait files [fangly]
45     * Bio::DB::Taxonomy::list
46         - Misc optimizations [fangly]
47         - Option -names of get_taxon() to help with ambiguous taxa [fangly]
48     * Bio::DB::Taxonomy::*
49         - get_num_taxa() returns the number of taxa in the database [fangly]
50     * Bio::DB::Fasta and Bio::DB::Qual
51         - support indexing an arbitrary list of files [fangly]
52         - user can supply an arbitrary index file name [fangly]
53         - new option to remove index file at the end [fangly]
54     * Bio::DB::Fasta
55         - now handles IUPAC degenerate residues [fangly]
57     [Bug fixes]
59     * [3240] Bio::AlignIO::stockholm now parses simple sequences [Bernd Web,
60       cjfields]
61     * [3237] Bio::DB::Fasta now allows blank lines between sequences, catches
62       instances where blank lines are within sequences [cjfields]
63     * Bio::DB::Fasta reports correct alphabet for files with multiple sequence
64       types [fangly]
65     * Bio::DB::Fasta rev-comps sequences other than DNA properly [fangly]
66     * [3238] Fixes for Bio::DB::SeqFeature::Store::DBI::Pg [Thomas Burkhard,
67       cjfields]
68     * Various fixes for Stockholm file indexing and processing [bosborne]
69     * Fix edge case in FASTQ parsing where sequence of length 1 and qual of 0
70       breaks parsing [cjfields]
71     * Fix case where Bio::Seq::Meta* objects with no meta information could not
72       be reverse-complemented [fangly]
73     * Fix bug for fields without aliases in Bio::DB::Query::HIVQuery [fangly]
74     * Fix Bio::PopGen::IO::phase: sort values lexically instead of numerically
75       when unsure that values will be numerical [fangly]
76     * Fix undef warnings in Bio::SeqIO::embl [fangly]
77     * Fix undef warnings in Bio::DB::Fasta and Bio::DB::Qual [fangly]
78     * Fix Bio::Tools::IUPAC should accept any sequence object [fangly]
79     * Fix for 'Inappropriate ioctl' in Bio::DB::Store::berkeleydb3 [Olivier
80       Sallou]
81     * Bio::SeqFeature::Generic SeqfeatureI compliance: methods primary_tag,
82       source_tag and display_name must return a string, not undef [fangly]
83     * Bio::SimpleAlign and Bio::Seq compliance with Bio::FeatureHolderI
84       add_SeqFeature takes a single argument [fangly]
85     * Use cross-platform filenames and temporary directory in
86       Bio::DB::Taxonomy::flatfile [fangly]
87     * Fix bug in Bio::DB::Taxonomy::list where taxa with no ancestors were not
88       properly identified as existing taxa in the database [fangly]
89     * Fix issue where a Bio::DB::Taxonomy::list object could not be created
90       without also passing a lineage to store [fangly]
91     * Prevent passing a directory to the gi2taxid option (-g) of
92       bp_classify_hits_kingdom.pl and remove an 'earlier declaration' warning
93       [fangly]
94     * Fixed bp_genbank2gff3.pl crash when missing source feature date [fangly]
97 1.6.901 May 18, 2011
99     [Notes]
101     * Use of AcePerl is deprecated; Ace.pm isn't actively maintained, and
102       modules using Ace will also be deprecated [lds, cjfields]
103     * Minor bug fix release
104     * Bio::SeqIO::gbxml tests require XML::SAX [hartzell]
105     * Address Build.PL issues when DBI is not present [hartzell]
106     * Skip gbxml.t and Interpro tests when modules not installed [cjfields]
107     * Remove deprecated code for perl 5.14.0 compat [cjfields]
108     * Due to schema changes and lack of support for older versions, support
109       for NeXML 0.9 is only (very) partially implemented.
110       See: https://redmine.open-bio.org/issues/3207
112     [Bug fixes]
114     * [3205] - small fix to Bio::Perl blast_sequence() to make compliant with
115       docs [genehack, cjfields]
116     * $VERSION for CPAN/cpanm-based installs was broken; force setting of
117       module version from dist_version (probably not the best way to do this,
118       but it seems to work) [rbuels, cjfields]
121 1.6.900 April 14, 201
123     [Notes]
125     * This will probably be the last release to add significant features to
126       core modules; subsequent releases will be for bug fixes alone.
127       We are planning on a restructuring of core for summer 2011, potentially
128       as part of the Google Summer of Code.  This may become BioPerl 2.0.
129     * Version bump represents 'just prior to v 1.7'.  We may have point
130       releases to deal with bugs, with increments of 1.6.901, 1.6.902, etc.
131       This code essentially is what is on the github master branch.
133     [New features]
135     * Core code updated for perl 5.12.x [cjfields, Charle Tilford]
136     * Bio::Tree refactor
137         - major overhaul of Bio::Tree code by Greg Jordan, fixes several bugs
138         - removal of Scalar::Util::weaken code, which was causing odd headaches
139           with premature GC, memory leaks with perl 5.10.0, etc [cjfields]
140     * Bio::DB::SeqFeature bug fixes for GBrowse2 compatibility [lds, scottcain,
141           many others]
142     * Bio::SeqIO::msout, Bio::SeqIO::mbsout - parsers for ms and mbs
143           [Warren Kretzschmar]
144     * Bio::SeqIO::gbxml
145         - bug 2515 - new contribution [Ryan Golhar, jhannah]
146     * Bio::Assembly::IO
147         - support for reading Maq, Sam and Bowtie files [maj]
148         - support for reading 454 GS Assembler (Newbler) ACE files [fangly]
149         - bug 2483: support for writing ACE files [Joshua Udall, fangly]
150         - bug 2599: support DBLINK annotation in GenBank files [cjfields]
151         - bug 2726: reading/writing granularity: whole scaffold or one contig
152           at a time [Joshua Udall, fangly]
153     * Bio::OntologyIO
154         - Added parsing of xrefs to OBO files, which are stored as secondary
155             dbxrefs of the cvterm [Naama Menda]
156         - General Interpro-related code refactors [dukeleto, rbuels, cjfields]
157     * PAML code updated to work with PAML 4.4d [DaveMessina]
159     [Bug fixes]
161     * [3198] - sort tabular BLAST hits by score [DaveMessina]
162     * [3196] - fix invalid metadata produced by latest Module::Build [cjfields]
163     * [3190] - RemoteBlast GAPCOSTS regex fix [Ali Walsh, cjfields]
164     * [3185] - Bio::Tools::SeqStats->get_mol_wt now gives correct MW
165                [cjfields]
166     * [3178] - fix tr/// issue in Bio::Range [Andrew Conley, cjfields]
167     * [3172] - Bio::DB::Fasta - catch possibly bad FASTA files [cjfields]
168     * [3164] - TreeFunctionsI syntax  bug [gjuggler]
169     * [3163] - AssemblyIO speedup [fangly]
170     * [3160] - Bio::SearchIO::Writer::TextResultWriter output [Paul Cantalupo,
171                hyphaltip]
172     * [3159] - add SwissPfam support to bp_index.PLS [hyphaltip]
173     * [3158] - fix EMBL file mis-parsing [cjfields]
174     * [3157] - Bio::Restriction::Analysis 'sizes' method fixed [Marc Perry,
175                cjfields]
176     * [3153] - fix SeqIO::swiss TagTree issues [Charles Tilford, cjfields]
177     * [3148] - URL change for UniProt [cjfields]
178     * [3145] - AXT off-by-1 error [Aaron Goodman, cjfields]
179     * [3136] - HMMer3 parser fixes [kblin]
180     * [3126] - catch description [Toshihiko Akiba]
181     * [3122] - Catch instances where non-seekable filehandles were being
182                seek'd w/o checking for status [Stefan Kirov, Roy Chaudhuri]
183     * [3121] - Bio::OntologyIO cannot parse the full InterPro XML file
184                [dukeleto, rbuels, cjfields]
185     * [3120] - bp_seqfeature_gff3.pl round-trip fixes [genehack, David Breimann,
186                jhannah]
187     * [3116,3117] - perl 5.12.x warnings fixed [cjfields, Charles Tilford]
188     * [3110] - Better 'namespace' support for bp_seqfeature_load.PLS [dbolser,
189                cjfields]
190     * [3107] - BLAST alignment column_from_residue_number() [cjfields]
191     * [3104] - Bio::Species single node hierarchies [Charles Tilford, cjfields]
192     * [3092, 3090] - parsing of BLAST HSP stats [Razi Khaja, cjfields]
193     * [3089] - HSPTableWriter missing methods [Robson de Souza, cjfields]
194     * [3086] - EMBL misparsing long tags [kblin, cjfields]
195     * [3085] - CommandExts and array of files [maj, hyphaltip]
196     * [3077] - Bio::SimpleAlign slice() now correctly computes seq coordinates
197                for alignment slices [Ha X. Dang, cjfields]
198     * [3076] - XMFA alignment strand wrong [Ha X., cjfields]
199     * [3073] - fix parsing of GenBank files from RDP [cjfields]
200     * [3068] - FASTQ parse failure with trailing 0 [cjfields]
201     * [3064] - All-gap midline BLAST report issues [cjfields]
202     * [3063] - BLASt report RID [Razi Khaja, cjfields]
203     * [3058] - SearchIO::fasta parsing [DaveMessina, cjfields]
204     * [3053] - LOCUS line formatting [M. Wayne, cjfields]
205     * [3039] - correct Newick output root node branch length [gjuggler,
206                DaveMessina]
207     * [3038] - SELEX alignment error [Bernd, cjfields]
208     * [3033] - PrimarySeq ID setting [Bernd, maj]
209     * [3032] - Fgenesh errors [Wes Barris, hyphaltip]
210     * [3034] - AlignIO::clustal output [Bernd, DaveMessina]
211     * [3031] - Parse algorithm ref for BLAST [Razi Khaja, cjfields]
212     * [3028] - Bio::TreeIO::nexus and FigTree compat [Kevin Balbi, cjfields]
213     * [3025] - Bio::SeqIO::embl infinite loop [Adam Sjøgren, cjfields]
214     * [3040, 3023, 2974, 2921, 2753, 2636, 2482] - PAML parser fixed, works with
215                PAML 4.4d [DaveMessina]
216     * [3015, 3022] - Bio::Restriction withrefm regexp [Emmanuel Quevillon,
217                DaveMessina]
218     * [3020] - GFF3Loader alias attribute [Nathan Weeks, cjfields]
219     * [3018, 3019, 3021] - gmap_f9 parsing [Kiran Mukhyala, cjfields]
220     * [3017] - using threads with Bio::DB::GenBank [cjfields]
221     * [3012] - Bio::Root::HTTPget fixes [maj, cjfields]
222     * [3011] - namespace support for SF::Store::DBI::Pg [Adam Witney, cjfields]
223     * [3002] - Bio::DB::EUtilities NCBI policy updates [cjfields]
224     * [3001] - seq identifier '0' dropped with FASTA [Michael Kuhn, maj]
225     * [2984] - let LocatableSeq decide on length of phylip aln [Adam Witney,
226                cjfields]
227     * [2983] - fix score/percent ID mixup [Alexie Papanicolaou]
228     * [2977] - TreeIO issues [DaveMessina]
229     * [2959] - Bio::SeqUtils->revcom_with_features [Roy Chaudhuri, maj]
230     * [2944] - Bio::Tools::GFF score [cjfields]
231     * [2942] - correct MapTiling output [maj]
232     * [2939] - PDB residue insertion codes [John May, maj]
233     * [2930] - PrimarySeqI term symbol [Adam Sjøgren, maj]
234     * [2928] - GuessSeqFormat raw [maj]
235     * [2926] - Bio:Tools::TandemRepeatsFinder seq_id [takadonet, cjfields]
236     * [2922] - open() directive issue [cjfields]
237     * [2915] - GenBank parser infinite loop [Francisco Ossandon, cjfields]
238     * [2901] - DNAStatistics div by zero error [Janet Young, cjfields]
239     * [2899] - SeqFeature::Store host issues [lstein, dbolser]
240     * [2897] - Add a "mask_below_threshold" method to Seq::Quality [dbolser,
241                cjfields]
242     * [2881] - .scf files don't' roundtrip [Adam Sjøgren, cjfields]
243     * [2876] - CDD search with RemoteBlast [Malcolm Cook]
244     * [2863] - Root::IO::_initialize_io causes crash [rbuels, maj, DaveMessina]
245     * [2845] - Bio::Seq::Quality gives seq with no ID [Tristan Lefebure, cjfields]
246     * [2843] - FeatureIO BED to GFF fails w/ no phase [cassjm cjfields]
247     * [2773] - Bio::Tree::Node premature GC [Morgan Price, cjfields]
248     * [2764] - add ID Tracker helper for SwissProt [heikki, cjfields]
249     * [2758] - Bio::AssemblyIO ace problems [fangly]
250     * [2744] - Bio::LocatableSeq::end [Bernd, cjfields]
251     * [2726] - ace file IO [Josh, fangly]
252     * [2700] - Refactor Build.PL [cjfields]
253     * [2673] - addition of simple Root-based clone() method [cjfields]
254     * [2648] - Bio::Assembly::Scaffold->get_all_seq_ids [dbolser, fangly]
255     * [2599] - support for DBLINK annotation in GenBank files [cjfields]
256     * [2594] - Bio::Species memory leak [cjfields]
257     * [2515] - GenBank XML parser [jhannah]
258     * [2499] - Method "pi" in package Bio::PopGen::Statistics [hyphaltip]
259     * [2483] - Bio::Assembly::IO::ace write_assembly implemented [fangly]
260     * [2350] - ID consistency btwn Bio::SeqI, Bio::Align::AlignI [fangly,
261                cjfields]
262     * [1572] - no docs Bio::Location::Simple/Atomic::trunc [hyphaltip]
264     [Deprecated]
266     * Bio::Expression modules - these were originally designed to go with the
267       bioperl-microarray suite of tools, however they have never been completed
268       and so have been removed from the distribution.  The original code has
269       been moved into the inactive bioperl-microarray suite. [cjfields]
271     [Other]
273     * Repository moved from Subversion (SVN) to
274       http://github.com/bioperl/bioperl-live [cjfields]
275     * Bug database has moved to Redmine (https://redmine.open-bio.org)
276     * Bio::Micrarray - the tools developed for ReSeq chip analysis by Marian
277       Thieme have been moved to their own distribution (Bio-Microarray).
278       [cjfields]
280 1.6.1   Sept. 29, 2009 (point release)
281     * No change from last alpha except VERSION and doc updates [cjfields]
283 1.6.0_6 Sept. 27, 2009 (sixth 1.6.1 alpha)
284     * Fix for silent OBDA bug related to FASTA validation [cjfields]
286 1.6.0_5 Sept. 27, 2009 (fifth 1.6.1 alpha)
287     * Possible fix for RT 49950 (Strawberry Perl installation) [cjfields]
288     * [RT 50048] - removed redundant VERSION, which was borking CPANPLUS
289       [cjfields]
290     * BioPerl.pod -> BioPerl.pm (Perl Best Practices) [cjfields]
292 1.6.0_4 Sept. 25, 2009 (fourth 1.6.1 alpha)
293     * WinXP test fixes [cjfields, maj]
294     * BioPerl.pod added for descriptive information, fixes CPAN indexing
295       [cjfields]
296     * Minor doc fixes [cjfields]
298 1.6.0_3 Sept. 22, 2009 (third 1.6.1 alpha)
299     * Fix tests failing due to merging issues [cjfields]
300     * More documentation updates for POD parsing [cjfields]
302 1.6.0_2 Sept. 22, 2009 (second 1.6.1 alpha)
303     * Bio::Root::Build
304         - fix YAML meta data generation [cjfields]
306 1.6.0_1 Sept. 15, 2009 (first 1.6.1 alpha)
307     * Bio::Align::DNAStatistics
308         - fix divide by zero problem [jason]
309     * Bio::AlignIO::*
310         - bug 2813 - fix faulty logic to detect end-of-stream [cjfields]
311     * Bio::AlignIO::stockholm
312         - bug 2796 - fix faulty logic to detect end-of-stream [cjfields]
313     * Bio::Assembly::Tools::ContigSpectrum
314         - function to score contig spectrum [fangly]
315     * Bio::DB::EUtilities
316         - small updates [cjfields]
317     * Bio::DB::Fasta
318         - berkeleydb database now autoindexes wig files and locks correctly
319           [lstein]
320     * Bio::DB::HIV
321         - various small updates for stability; tracking changes to LANL
322           database interface [maj]
323     * Bio::DB::SeqFeature (lots of updates and changes)
324         - add Pg, SQLite, and faster BerkeleyDB implementations [lstein, scain]
325         - bug 2835 - patch [Dan Bolser]
326         - bug RT 44535 - patch FeatureFileLoader [Cathy Gresham]
327     * Bio::DB::SwissProt
328         - bug 2764 - idtracker() method [cjfields, courtesy Neil Saunders]
329     * Bio::Factory::FTLocationFactory
330         - mailing list bug fix [cjfields]
331     * Bio::LocatableSeq
332         - performance work on column_from_residue_number [hartzell]
333     * Bio::Matrix::IO::phylip
334         - bug 2800 - patch to fix phylip parsing [Wei Zou]
335     * Bio::Nexml
336         - Google Summer of Code project from Chase Miller - parsers for Nexml
337           file format [maj, chmille4]
338     * Bio::PopGen
339         - Make Individual, Population, Marker objects AnnotatableI [maj]
340         - simplify LD code [jason]
341     * Bio::RangeI
342         - deal with empty intersection [jason]
343     * Bio::Restriction
344         - significant overhaul of Bio::Restriction system: complete support for
345           external and non-palindromic cutters. [maj]
346     * Bio::Root::Build
347         - CPANPLUS support, no automatic installation [sendu]
348     * Bio::Root::IO
349         - allow IO::String (regression fix) [cjfields]
350         - catch unintentional undef values [cjfields]
351         - throw if non-fh is passed to -fh [maj]
352     * Bio::Root::Root/RootI
353         - small debugging and core fixes [cjfields]
354     * Bio::Root::Test
355         - bug RT 48813 - fix for Strawberry Perl bug [kmx]
356     * Bio::Root::Utilities
357         - bug 2737 - better warnings [cjfields]
358     * Bio::Search
359         - tiling completely refactored, HOWTO added [maj]
360           NOTE : Bio::Search::Hit::* classes do not use this code directly; we
361           will deprecate usage of the older tiling code in the next BioPerl
362           release
363         - small fixes [cjfields]
364     * Bio::SearchIO
365         - Infernal 1.0 output now parsed [cjfields]
366         - new parser for gmap -f9 output [hartzell]
367         - bug 2852 - fix infinite loop in some output [cjfields]
368         - blastxml output now passes all TODO tests [cjfields]
369         - bug 2346, 2850 - psl and exonerate parsing fixes [rbuels, jhannah, bvecchi, YAPC hackathon]
370         - RT 44782 - GbrowseGFF writer now catches evalues [Allen Day]
371         - bug 2575 - add two columns of additional output to HSPTableWriter [cjfields]
372     * Bio::Seq::LargePrimarySeq
373         - delete tempdirs [cjfields]
374         - bug fixes [rbuels, jhannah, bvecchi, YAPC hackathon]
375     * Bio::Seq::Quality
376         - extract regions based on quality threshold value [Dan Bolser, heikki]
377         - bug 2847 - resolve threshold issue (rbuels, jhannah, bvecchi)
378     * Bio::SeqFeature::Lite
379         - various Bio::DB::SeqFeature-related fixes [lstein]
380     * Bio::SeqFeature::Tools::TypeMapper
381         - additional terms for GenBank to SO map [scain]
382     * Bio::SeqIO::chadoxml
383         - bug 2785 - patch to get this working for bp_seqconvert [cjfields]
384     * Bio::SeqIO::embl
385         - support for CDS records [dave_messina, Sylvia]
386     * Bio::SeqIO::fastq
387         - complete refactoring to handle all FASTQ variants, perform validation,
388           write output. API now conforms with other Bio* parsers and the rest of
389           Bio::SeqIO (e.g. write_seq() creates fastq output, not fasta output).
390           [cjfields]
391     * Bio::SeqIO::genbank
392         - bug 2784 - fix DBSOURCE issue [Phillip Garland]
393         - bug RT 44536 - support for UniProt/UniProtKB tests [cjfields]
394     * Bio::SeqIO::largefasta
395         - parser returns a Bio::Seq::LargePrimarySeq [jhannah]
396     * Bio::SeqIO::raw
397         - add option for 'single' and 'multiple'
398     * Bio::SeqIO::scf
399         - bug 2881 - fix scf round-tripping [Adam Sj¿gren]
400     * Bio::SeqUtils
401         - bug 2766, 2810 - copy over tags from features, doc fixes [David
402           Jackson]
403     * Bio::SimpleAlign
404         - bug 2793 - patch for add_seq index issue [jhannah, maj]
405         - bug 2801 - throw if args are required [cjfields]
406         - bug 2805 - uniq_seq returns SimpleAlign and hash ref of sequence types
407           [Tristan Lefebure, maj]
408         - bug fixes from YAPC hackathon [rbuels, jhannah, bvecchi]
409         - fix POD and add get_SeqFeatures filter [maj]
410     * Bio::Tools::dpAlign
411         - add support for LocatableSeq [ymc]
412         - to be moved to a separate distribution [cjfields, rbuels]
413     * Bio::Tools::EUtilities
414         - fix for two bugs from mail list [Adam Whitney, cjfields]
415         - add generic ItemContainerI interface for containing same methods
416           [cjfields]
417     * Bio::Tools::HMM
418         - fix up code, add more warnings [cjfields]
419         - to be moved to a separate distribution [cjfields, rbuels]
420     * Bio::Tools::Primer3
421         - bug 2862 - fenceposting issue fixed [maj]
422     * Bio::Tools::Run::RemoteBlast
423         - tests for remote RPS-BLAST [mcook]
424     * Bio::Tools::SeqPattern
425         - bug 2844 - backtranslate method [rbuels, jhannah, bvecchi]
426     * Bio::Tools::tRNAscanSE
427         - use 'gene' and 'exon' for proper SO, ensure ID is unique [jason]
428     * Bio::Tree::*
429         - bug 2456 - fix reroot_tree(), added create_node_on_branch() [maj]
430     * Bio::Tree::Statistics
431         - several methods for calculating Fitch-based score, internal trait
432           values, statratio(), sum of leaf distances [heikki]
433     * Bio::Tree::Tree
434         - bug 2869 - add docs indicating edge case where nodes can be
435           prematurely garbage-collected [cjfields]
436         - add as_text() function to create Tree as a string in specified format
437           [maj]
438     * Bio::Tree::TreeFunctionsI
439         - bug 2877 - fix bug where bootstrap assigned to the wrong node [Tristan
440           Lefebure, maj]
441     * Bio::TreeIO::newick
442         - fix small semicolon issue [cjfields]
443     * scripts
444         - update to bp_seqfeature_load for SQLite [lstein]
445         - hivq.pl - commmand-line interface to Bio::DB::HIV [maj]
446         - fastam9_to_table - fix for MPI output [jason]
447         - gccalc - total stats [jason]
448     * General Stuff
449         - POD cleanup re: FEEDBACK section [maj, cjfields]
450         - cleanup or fix dead links [cjfields]
451         - Use of no_* methods (indicating 'number of something') is deprecated
452           in favor of num_* [cjfields]
453         - lots of new tests for the above bugs and refactors [everyone!]
454         - new template for Komodo text editor [cjfields]
456 1.6.0 Winter 2009
457     * Feature/Annotation rollback
458         - Problematic changes introduced prior to the 1.5 release have been
459           rolled back. These changes led to subtle bugs involving operator
460           overloading and interface methods.
461         - Behavior is very similar to that for BioPerl 1.4, with tag values
462           being stored generically as simple scalars. Results in a modest
463           speedup.
464     * Bio::Graphics
465         - Split into a separate distribution on CPAN, primarily so development
466           isn't reliant on a complete BioPerl release.
467         - Bio::Graphics::Pictogram has been renamed to Bio::Draw::Pictogram but
468           is only available via Subversion (via bioperl-live main trunk)
469     * Bio::Root::Test
470         - Common test bed for all BioPerl modules
471     * Bio::Root::Build
472         - Common Module::Build-based subclass for all BioPerl modules
473     * Bio::DB::EUtilities
474         - Complete refactoring to split up parsing (Bio::Tools::EUtilities),
475           parameter handling (Bio::Tools::EUtilities::EUtilParameters),
476           and user agent request posting and retrieval
477     * Test implementation and reorganization
478         - Tests have been reorganized into groups based on classes or use
479           cases.
480         - Automated test coverage is now online:
481           http://www.bioperl.org/wiki/Test_Coverage
482         - After this release, untested modules will be moved into a
483           separate developer distribution until tests can be derived.
484           Also, new modules to be added are expected to have a test suite
485           and adequate test coverage.
487 1.5.2 Developer release
489     Full details of changes since 1.5.1 are available online at:
490     http://www.bioperl.org/wiki/Change_log
491     The following represents a brief overview of the most important changes.
493     o Bio::Map
494       - Overhaul. Brand new system fully allows markers to have multiple
495         positions on multiple maps, and to have relative positions. Should be
496         backward compatible.
498     o Bio::Taxonomy
499       - This module and all the modules in the Taxonomy directory now
500         deprecated in favour of Bio::Taxon and Bio::Tree::Tree
502     o Bio::DB::Taxonomy
504       - Taxonomy.pm
505         * get_Taxonomy_Node() eventually to be deprecated, renamed get_taxon().
507         * New methods ancestor(), each_Descendent() and _handle_internal_id().
509         * Allows for different database modules to create Bio::Taxon objects
510           with the same internal id when the same taxon is requested from each.
512       - flatfile.pm
513         * get_Children_Taxids() is deprecated, superceded by each_Descendent().
515         * No longer includes the fake root node 'root'; there are multiple roots
516           now (10239, 12884, 12908, 29384 and 131567). Consistent with entrez.pm
518       - entrez.pm
519         * get_node() has new option -full
521         * Caches data retrieved from website
523     o Bio::Species
524       - Now a Bio::Taxon. Carries out the species name -> specific name munging
525         that Bio::DB::Taxonomy modules and SeqIO modules used to do, for
526         backward compatability in species() method.
528     o Bio::Search and Bio::SearchIO
529       - Overhaul. The existing system has been sped up via some minor changes
530         (mostly gain-of-function to the API). Bio::PullParserI is introduced
531         as a potential eventual replacment for the existing system, though as
532         yet only a Hmmpfam parser exists written using it.
535 1.5.1 Developer release
537     o Major problem with how Annotations were written out with
538       Bio::Seq is fixed by reverting to old behavior for
539       Bio::Annotation objects.
541     o Bio::SeqIO
543      - genbank.pm
544        * bug #1871; REFLOOP' parsing loop, I changed the pattern to
545          expect at l east 9 spaces at the beginning of a line to
546          indicate line wrapping.
548        * Treat multi-line SOURCE sections correctly, this defect broke
549          both common_name() and classification()
551        * parse swissprot fields in genpept file
553        * parse WGS genbank records
555      - embl.pm
556         * Changed regexp for ID line. The capturing parentheses are
557           the same, the difference is an optional repeated-not-semi-
558           colon expression following the captured \S+. This means the
559           regexp works when the division looks like /PRO;/ or when the
560           division looks like /ANG ;/ - the latter is from EMBL
561           repbase
563         * fix ID line parsing: the molecule string can have spaces in
564           it. Like: "genomic DNA"
566      - swiss.pm: bugs  #1727, #1734
568      - entrezgene.pm
569         * Added parser for entrezgene ASN1 (text format) files.
570           Uses Bio::ASN1::EntrezGene as a low level parser (get it from CPAN)
572     o Bio::AlignIO
574      -  maf.pm coordinate problem fixed
576     o Bio::Taxonomy and Bio::DB::Taxonomy
578      - Parse NCBI XML now so that nearly all the taxonomy up-and-down
579        can be done via Web without downloading all the sequence.
581     o Bio::Tools::Run::RemoteBlast supports more options and complies
582       to changes to the NCBI interface. It is reccomended that you
583       retrieve the data in XML instead of plain-text BLAST report to
584       insure proper parsing and retrieval of all information as NCBI
585       fully expects to change things in the future.
587     o Bio::Tree and Bio::TreeIO
589       - Fixes so that re-rooting a tree works properly
591       - Writing out nhx format from a newick/nexus file will properly output
592         bootstrap information.  The use must move the internal node labels over
593         to bootstraps.
594          for my $node ( grep { ! $_->is_Leaf } $tree->get_nodes ) {
595             $node->bootstrap($node->id);
596             $node->id('');
597          }
598       - Nexus parsing is much more flexible now, does not care about
599         LF.
601       - Cladogram drawing module in Bio::Tree::Draw
603       - Node height and depth now properly calculated
605       - fix tree pruning algorithm so that node with 1 child gets merged
607     o Graphics tweaks.  Glyph::xyplot improved.  Many other small-medium sized
608       bugs and improvements were added, see Gbrowse mailing list for most of
609       these.
611     o Bio::DB::GFF partially supports GFF3.  See information about
612       gff3_munge flag in scripts/Bio-DB-GFF/bulk_load_gff.pl.
614     o Better location parsing in Bio::Factory::FTLocationFactory -
615       this is part of the engine for parsing EMBL/GenBank feature table
616       locations.  Nested join/order-by/complement are allowed now
618     o Bio::PrimarySeqI->translate now takes named parameters
620     o Bio::Tools::Phylo::PAML - parsing RST (ancestral sequence
621       reconstruction) is now supported.  Parsing different models and
622       branch specific parametes are now supported.
624     o Bio::Factory::FTLocationFactory - parse hierarchical locations
625       (joins of joins)
627     o Bio::Matrix::DistanceMatrix returns arrayrefs instead of arrays
628       for getter/setter functions
630     o Bio::SearchIO
632       - blast bug #1739; match scientific notation in score
633         and possible e+ values
635       - blast.pm reads more WU-BLAST parameters and parameters, match
636         a full database pathname,
638       - Handle NCBI WEB and newer BLAST formats specifically
639         (Query|Sbjct:) match in alignment blocks can now be (Query|Sbjct).
641       - psl off-by-one error fixed
643       - exonerate parsing much improved, CIGAR and VULGAR can be parsed
644         and HSPs can be constructed from them.
646       - HSPs query/hit now have a seqdesc field filled out (this was
647         always available via $hit->description and
648         $result->query_description
650       - hmmer.pm can parse -A0 hmmpfam files
652       - Writer::GbrowseGFF more customizeable.
654     o Bio::Tools::Hmmpfam
655       make e-value default score displayed in gff, rather than raw score
656       allow parse of multiple records
659 1.5 Developer release
661     o Bio::Align::DNAStatistics and Bio::Align::ProteinStatistics
662       provide Jukes-Cantor and Kimura pairwise distance methods,
663       respectively.
665     o Bio::AlignIO support for "po" format of POA, and "maf";
666       Bio::AlignIO::largemultifasta is a new alternative to
667       Bio::AlignIO::fasta for temporary file-based manipulation of
668       particularly large multiple sequence alignments.
670     o Bio::Assembly::Singlet allows orphan, unassembled sequences to
671       be treated similarly as an assembled contig.
673     o Bio::CodonUsage provides new rare_codon() and probable_codons()
674       methods for identifying particular codons that encode a given
675       amino acid.
677     o Bio::Coordinate::Utils provides new from_align() method to build
678       a Bio::Coordinate pair directly from a
679       Bio::Align::AlignI-conforming object.
681     o Bio::DB::Biblio::eutils is a class for querying NCBI's Eutils.
682       Send a Pubmed, Pubmed Central, Entrez, or other query to NCBI's
683       web service using standard Pubmed query syntax, and retrieve
684       results as XML.
686     o Bio::DB::GFF has various sundry bug fixes.
688     o Bio::FeatureIO is a new SeqIO-style subsystem for
689       writing/reading genomic features to/from files.  I/O classes
690       exist for BED, GTF (aka GFF v2.5), and GFF v3.  Bio::FeatureIO
691       classes only read/write Bio::SeqFeature::Annotated objects.
692       Notably, the GFF v3 class requires features to be typed into the
693       Sequence Ontology.
695     o Bio::Graph namespace contains new modules for manipulation and
696       analysis of protein interaction graphs.
698     o Bio::Graphics has many bug fixes and shiny new glyphs.
700     o Bio::Index::Hmmer and Bio::Index::Qual provide multiple-file
701       indexing for HMMER reports and FASTA qual files, respectively.
703     o Bio::Map::Clone, Bio::Map::Contig, and Bio::Map::FPCMarker are
704       new objects that can be placed within a Bio::Map::MapI-compliant
705       genetic/physical map; Bio::Map::Physical provides a new physical
706       map type; Bio::MapIO::fpc provides finger-printed clone mapping
707       import.
709     o Bio::Matrix::PSM provide new support for postion-specific
710       (scoring) matrices (e.g. profiles, or "possums").
712     o Bio::Ontology::Ontology and Bio::Ontology::Term objects can now
713       be instantiated without explicitly using Bio::OntologyIO.  This
714       is possible through changes to Bio::Ontology::OntologyStore to
715       download ontology files from the web as necessary.  Locations of
716       ontology files are hard-coded into
717       Bio::Ontology::DocumentRegistry.
719     o Bio::PopGen includes many new methods and data types for
720       population genetics analyses.
722     o New constructor to Bio::Range, unions().  Given a list of
723       ranges, returns another list of "flattened" ranges --
724       overlapping ranges are merged into a single range with the
725       mininum and maximum coordinates of the entire overlapping group.
727     o Bio::Root::IO now supports -url, in addition to -file and -fh.
728       The new -url argument allows one to specify the network address
729       of a file for input.  -url currently only works for GET
730       requests, and thus is read-only.
732     o Bio::SearchIO::hmmer now returns individual Hit objects for each
733       domain alignment (thus containing only one HSP); previously
734       separate alignments would be merged into one hit if the domain
735       involved in the alignments was the same, but this only worked
736       when the repeated domain occured without interruption by any
737       other domain, leading to a confusing mixture of Hit and HSP
738       objects.
740     o Bio::Search::Result::ResultI-compliant report objects now
741       implement the "get_statistics" method to access
742       Bio::Search::StatisticsI objects that encapsulate any
743       statistical parameters associated with the search (e.g. Karlin's
744       lambda for BLAST/FASTA).
746     o Bio::Seq::LargeLocatableSeq combines the functionality already
747       found in Bio::Seq::LargeSeq and Bio::LocatableSeq.
749     o Bio::SeqFeature::Annotated is a replacement for
750       Bio::SeqFeature::Generic.  It breaks compliance with the
751       Bio::SeqFeatureI interface because the author was sick of
752       dealing with untyped annotation tags.  All
753       Bio::SeqFeature::Annotated annotations are Bio::AnnotationI
754       compliant, and accessible through Bio::Annotation::Collection.
756     o Bio::SeqFeature::Primer implements a Tm() method for primer
757       melting point predictions.
759     o Bio::SeqIO now supports AGAVE, BSML (via SAX), CHAOS-XML,
760       InterProScan-XML, TIGR-XML, and NCBI TinySeq formats.
762     o Bio::Taxonomy::Node now implements the methods necessary for
763       Bio::Species interoperability.
765     o Bio::Tools::CodonTable has new reverse_translate_all() and
766       make_iupac_string() methods.
768     o Bio::Tools::dpAlign now provides sequence profile alignments.
770     o Bio::Tools::GFF now parses GFF version 2.5 (a.k.a. GTF).
772     o Bio::Tools::Fgenesh, Bio::Tools::tRNAscanSE are new report
773       parsers.
775     o Bio::Tools::SiRNA includes two new rulesets (Saigo and Tuschl)
776       for designing small inhibitory RNA.
778     o Bio::Tree::DistanceFactory provides NJ and UPGMA tree-building
779       methods based on a distance matrix.
781     o Bio::Tree::Statistics provides an assess_bootstrap() method to
782       calculate bootstrap support values on a guide tree topology,
783       based on provided bootstrap tree topologies.
785     o Bio::TreeIO now supports the Pagel (PAG) tree format.
787 1.4 branch
789 1.4.1
791   o Improvements to Bio::AlignIO::nexus for parsing TreeBase nexus files
793   o Bio::Graphics will work with gd1 or gd2
795   o Bio::SearchIO
796    - hmmer.pm Better hmmpfam parsing, fix bug for small number of alignment outputs
797      (RF lines alone)
798    - blast.pm Parse multi-line query fields properly
799    - small speed improvements to blasttable.pm and others
801   o Bio::DB::Taxonomy has better support for hierarchy traversal so that
802     Bio::Taxonomy::Node can be as simple as Bio::Species object while still
803     supporting more complex queries
806 1.4. Stable major release
808 Since initial 1.2.0, 3000 separate changes have been made to make this release.
810    o installable scripts
812    o global module version from Bio::Root:Version
814    o Bio::Graphics
815       - major improvements; SVG support
817    o Bio::Popgen
818      - population genetics
819      - support several population genetics types of questions.
820      - Tests for statistical neutrality of mutations
821        (Fu and Li's D/F, Tajima's D) are in Bio::PopGen::Statistics.
822        Tests of population structure (Wright's F-statistic: Fst) is in
823        Bio::PopGen::PopStats. Calculating composite linkage
824        disequilibrium (LD) is available in Bio::PopGen::Statistics as
825        well.
826      - Bio::PopGen::IO for reading in prettybase (SeattleSNPs)
827        and csv (comma delimited formatted) data.
829      - a directory for implementing population simulations has
830        been added Bio::PopGen::Simulation and 2 simulations - a
831        Coalescent and a simple single-locus multi-allele genetic drift
832        simulation have been provided.  This replaces the code in
833        Bio::Tree::RandomTree which has been deprecated until proper
834        methods for generating random phylogenetic trees are
835        implemented.
837    o Bio::Restriction
838       - new restrion analysis modules
840    o Bio::Tools::Analysis
841       - web based DNA and Protein analysis framework and several
842         implementations
844    o Bio::Seq::Meta
845      - per residue annotable sequences
847    o Bio::Matrix
848       - Bio::Matrix::PSM - Position Scoring Matrix
849       - Bio::Matrix::IO has been added for generalized parsing of
850         matrix data.  Matrix::IO::scoring and Matrix::IO::phylip are
851         initial implementations for parsing BLOSUM/PAM and Phylip
852         Distance matricies respectively.  A generic matrix
853         implementation for general use was added in
854         Bio::Matrix::Generic.
856    o Bio::Ontology
857      - major changes
859    o Bio:Tree
861    o Bio::Tools::SiRNA, Bio::SeqFeature::SiRNA
862      - small inhibitory RNA
864    o Bio::SeqFeature::Tools
865      - seqFeature mapping tools
866      - Bio::SeqFeature::Tools::Unflattener.pm
867        -- deal with mapping GenBank feature collections into
868           Chado/GFF3 processable feature sets (with SO term mappings)
870    o Bio::Tools::dpAlign
871      - pure perl dynamic programming sequence alignment
872      - needs Bioperl-ext
874    o new Bio::SearchIO formats
875      - axt and psl:  UCSC formats.
876      - blasttable: NCBI -m 8 or -m 9 format from blastall
878    o new Bio::SeqIO formats
879      - chado, tab, kegg, tigr, game
880      - important fixes for old modules
882    o Bio::AlignIO: maf
884    o improved Bio::Tools::Genewise
886    o Bio::SeqIO now can recongnize sequence formats automatically from
887      stream
889    o new parsers in Bio::Tools:
890       Blat, Geneid, Lagan, Mdust, Promoterwise, PrositeScan,
892    o Bio::DB::Registry bugs fixed
893      - BerkeleyDB-indexed flat files can be used by the OBDA system
894      - Multiple seqdatabase.ini locations in OBDA_SEARCH_PATH are all
895        used by the OBDA system
897    o several new HOWTOs
898      - SimpleWebAnalysis, Trees, Feature Annotation, OBDA Access, Flat
899        Databases
901    o hundreds of new and improved files
904    o
905    o Bio::Tree::AlleleNode has been updated to be a container of
906      an Bio::PopGen::Individual object for use in the Coalescent simulations.
909 1.2 Branch
911 1.2.3 Stable release update
912     o Bug #1475 - Fix and add speedup to spliced_seq for remote location
913                   handling.
914     o Bug #1477 - Sel --> Sec abbreviation fixed
915     o Fix bug #1487 where paring in-between locations when
916       end < start caused the FTLocationFactory logic to fail.
917     o Fix bug #1489 which was not dealing with keywords as an
918       arrayref properly (this is fixed on the main trunk because
919       keywords returns a string and the array is accessible via
920       get_keywords).
921     o Bio::Tree::Tree memory leak (bug #1480) fixed
922       Added a new initialization option -nodelete which
923       won't try and cleanup the containing nodes if this
924       is true.
925      o Bug with parsing labeled nodes with Bio::TreeIO::newick fixed
926        this was only present on the branch for the 1.2.1 and 1.2.2 series
927        - Also merged main trunk changes to the branch which make
928          newick -> nhx round tripping more effective (storing branch length
929          and bootstrap values in same locate for NodeNHX and Node
930          implementations.)  Fixes to TreeIO parsing for labeled internal
931          also required small changes to TreeIO::nhx.  Improved
932          tests for this module as well.
933     o Bio::SearchIO
934       - Fixed bugs in BLAST parsing which couldn't parse NCBI
935         gapped blast properly (was losing hit significance values due to
936         the extra unexpeted column).
937       - Parsing of blastcl3 (netblast from NCBI) now can handle case of
938         integer overflow (# of letters in nt seq dbs is > MAX_INT)
939         although doesn't try to correct it - will get the negative
940         number for you.  Added a test for this as well.
941       - Fixed HMMER parsing bug which prevented parsing when a hmmpfam report
942         has no top-level family classification scores but does have scores and
943         alignments for individual domains.
944       - Parsing FASTA reports where ungapped percent ID is < 10 and the
945         regular expression to match the line was missing the possibility of
946         an extra space.  This is rare, which is why we probably did not
947         catch it before.
948       - BLAST parsing picks up more of the statistics/parameter fields
949         at the bottom of reports.  Still not fully complete.
950       - SearchIO::Writer::HTMLResultWriter and TextResultWriter
951         were fixed to include many improvements and added flexiblity
952         in outputting the files.  Bug #1495 was also fixed in the process.
953      o Bio::DB::GFF
954       - Update for GFF3 compatibility.
955       - Added scripts for importing from UCSC and GenBank.
956       - Added a 1.2003 version number.
957      o Bio::Graphics
958       - Updated tutorial.
959       - Added a 1.2003 version number.
960      o SeqIO::swiss Bug #1504 fixed with swiss writing which was not
961        properly writing keywords out.
962      o Bio::SeqIO::genbank
963       - Fixed bug/enhancement #1513 where dates of
964         the form D-MMM-YYYY were not parsed.  Even though this is
965         invalid format we can handle it - and also cleanup the date
966         string so it is properly formatted.
967       - Bug/enhancement #1517 fixed so that SEGMENT line can be parsed
968         and written with Genbank format.  Similarly bug #1515 is fixed to
969         parse in the ORIGIN text.
970      o Bio::SeqIO::fasta, a new method called preferred_id_type allows you
971        to specify the ID type, one of (accession accession.version
972        display primary).  See Bio::SeqIO::preferred_id_type method
973        documentation for more information.
974      o Unigene parsing updated to handle file format changes by NCBI
976 1.2.2 Stable release update
978     o A series of bug fixes of the Bio::OntologyIO dagflat-related parsers:
979       - auto-discover ontology name
980       - bug in parsing relationships when certain characters are in the term
981       - fixed hard-coded prefix for term identifiers
982       - various smaller issues
984     o Fixed bug in Bio::Annotation::OntologyTerm of not implementing all
985       of Bio::Ontology::TermI
987     o brought the OBDA Registry code up to latest specs
989     o Bio::DB::GenBank
990       - eutils URL change
991       - accession number retrieval fixed
993     o Bio::SearchIO::blast - fix bug #1443 (missing last hits), parse megablast
995     o Bio::SearchIO::Writer::(HTML|Text)ResultWriter fix bugs #1458,
996       #1459 which now properly report alignment start/end info
997       for translated BLAST/FASTA searches.
999     o Bio::TreeIO::newick can parse labeled internal nodes
1001     o Bio::Tools::BPbl2seq can properly report strand info for HSPs
1002       for BLASTX if if you provide -report_type => 'BLASTX' when
1003       initializing a BPbl2seq object.  Bioperl 1.3 will have better
1004       support for bl2seq in the SearchIO system.
1006     o Bio::Root::IO support a -noclose boolean flag which will not
1007       close a filehandle upon object cleanup - useful when sharing
1008       a filehandle among objects.  Additionally code added s.t.
1009       STDOUT/STDIN/STDERR will never be closed by Root::IO cleanup.
1011     o Bio::Tools::Genemark bug #1435 fixed which was missing last prediction
1013     o Bio::SeqIO::genbank
1014       - bug #1456 fixed which generated extra sequence lines
1015       - write moltype correctly for genpept
1017 1.2.1 Stable release update
1019     o Inclusion of WrapperBase, a needed component for StandAloneBlast
1021     o Addition from main trunk of Ontology objects, principly to allow
1022       BioSQL releases against 1.2.1
1024     o Fixes and cleanup of Bio::Coordinate modules
1026     o A fix to Bio::Index::EMBL allowing  retrieval of entries using
1027       the primary accession number
1029     o Other bug fixes, including bpindex GenBank fix
1031     o Bio::SeqIO::genbank bug #1389 fixed
1033 1.2  Stable major release
1035     o More functionality added to Bio::Perl, the newbie module
1037     o Bug fixes in Bio::TreeIO::newick fixes bug introduced in 1.0.2
1038       Support for New Hampshire Extended (NHX) format parsing.
1040     o Bio::Tools added support for parsing Genomewise, Pseudowise, Est2Genome,
1041       Tmhmm, SignalP, Seg, RepeatMasker, FootPrinter, and a lightweight
1042       Hmmpfam parser.
1044     o New ontology parsing Bio::Ontology
1046     o Bug fixes in Bio::SearchIO for HMMer parsing, support for
1047       multi-report (mlib) fasta reports, support for waba and exonerate.
1049     o Bio::ClusterIO for parsing Unigene clusters
1051     o Bio::Assembly added for representing phrap and ace assembly clusters.
1053     o Rudimentary support for writing Chado XML (see
1054       GMOD project: www.gmod.org for more information)
1056     o Bio::Coordinate for mapping between different coordinate systems such
1057       as protein -> cDNA -> Exon -> DNA and back.  Useful for mapping
1058       features into different coordinate systems.
1060     o Bio::DB::GenBank/Bio::DB::GenPept now support Entrez queries
1061       with the get_Stream_by_query method and supports the latest
1062       NCBI eutils interface.
1064     o Bugs fixed in Bio::SeqFeature::Collection an in-memory fast
1065       object for extracting subsets of features : currently only
1066       supports extraction by location.
1068 1.1.1 Developer release
1070     o Deprecated modules are now listed in the DEPRECATED file
1072     o New HowTo documents located in doc/howto describing
1073       a domain of Bioperl.
1075     o Note that bugs are now stored at redmine.open-bio.org/projects/bioperl/
1076       and all old bugs are searchable through the bugzilla interface.
1078     o Several reported bugs in Bio::Tools::Sigcleave and Bio::SimpleAlign
1079       have been addressed.
1081     o Support for Genewise parsing in Bio::Tools::Genewise
1083     o Start of Ontology framework with Bio::Ontology
1085     o Speedup to the Bio::Root::Root object method _rearrange.
1086       A global _load_module method was implemented to simplify the
1087       dynamic loading of modules ala Bio::SeqIO::genbank.  This
1088       method is now used by all the XXIO (AlignIO,TreeIO,SearchIO,SeqIO,
1089       etc).
1091     o Several performance improvements to sequence parsing in Bio::SeqIO.
1092       Attempt to speedup by reducing object creation overhead.
1094     o Bio::DB::GenBank and Bio::DB::GenPept use the NCBI's approved
1095       method for sequence retrieval with their E-utils CGI scripts.
1096       More work to support Entrez queries to their fullest is planned
1097       before 1.2 release.
1099     o Numerous fixes to Bio::SearchIO and sequence parsing (swissprot)
1101 1.1 Developer release
1103     o Bio::Tools::Run has been broken off into a new pkg bioperl-run,
1104       this separation removes some of the complexity in our test suite
1105       and separates the core modules in bioperl from those that need
1106       external programs to run.
1108     o With latest ExtUtils::MakeMaker module installed SGI/IRIX should
1109       not run into trouble running the makefile
1111     o Bio::Location and Bio::SeqIO::FTHelper are fixed to properly
1112       read,create,and write locations for grouped/split locations
1113       (like mRNA features on genomic sequence).
1115     o Bio::Tools::Phlyo added for wrappers for parsing Molphy (protml)
1116       and PAML (codeml,aaml, etc) parsing.
1118     o Bio::Tree:: objects expanded to handle testing monophyly,
1119       paraphyly, least common ancestor, etc.
1121     o Bio::Coordinate for mapping locations from different coordinate spaces
1123     o Bio::SearchIO::waba added for parsing WABA, Bio::SearchIO::hmmer
1124       added for parsing hmmpfam and hmmsearch output.
1126     o Bio::SearchIO::Writer::TextResultWriter for outputting
1127       a pseudo-blast textfile format
1130 1.0.2 Bug fix release
1132     o Note: The modules Bio::DB::GenBank and Bio::DB::GenPept provided
1133       in this release will not work after December 2002 when NCBI
1134       shuts off the old Entrez cgi scripts.  We have already fixed
1135       on our main development branch and the functionality will be
1136       available in the next stable bioperl release (1.2) slated for
1137       Fall 2002.
1139     o Numerous parsing bugs in Bio::SearchIO::fasta found through
1140       testset by Robin Emig.  These were fixed as was the get_aln
1141       method in Bio::Search::HSP::GenericHSP to handle the extra
1142       context sequence that is provided with a FastA alignment.
1144     o Migrating differences between Bio::Search::XX::BlastXX to
1145       Bio::Search::XX::GenericXX objects.  This included mechanism
1146       to retrieve whole list of HSPs from Hits and whole list of Hits from
1147       Results in addition to the current next_XX iterator methods that
1148       are available.  Added seq_inds() method to GenericHSP which identifies
1149       indexes in the query or hit sequences where conserved,identical,gaps,
1150       or mismatch residues are located (adapted from Steve Chervitz's
1151       implementation in BlastHSP).
1153     o Bio::DB::GFF bugs fixed and are necessary for latest GBrowse release.
1154       Bio::DB::GFF::RelSegment is now Bio::SeqI compliant.
1156     o Bio::Graphics glyph set improved and extended for GBrowse release
1158     o Bio::Tree::Tree get_nodes implementation improvement thanks
1159       to Howard Ross notice performance problem when writing out
1160       unbalanced trees.
1162     o Bio::Location::Fuzzy::new named parameter -loc_type became
1163       -location_type, Bio::Location::Simple::new named parameter
1164       -seqid becamse -seq_id.
1166     o Fixed major Bio::AlignIO::emboss parsing bug on needle output,
1167       was mis-detecting that gaps should be placed at the beginning of
1168       the alignment when the best alignment starts internally in the
1169       sequence.
1171 1.0.1 Bug fix release
1173     o Minor bug fixes to Bio::DB:GFF.  Glyph sets improved.
1175     o Parser fixes in SearchIO blast, fasta for more complete WU BLAST
1176       and mixed (3.3 - 3.4) versions of FASTA.
1178     o Small API change to add methods for completeness across
1179       implementations of Bio::Search objects.  These new methods
1180       in the interface are implemented by the GenericXX object as well
1181       as the BlastXX objects.
1182         * Bio::Search::Result::ResultI
1183          - hits() method returns list of all Hits (next_hit is an
1184            iterator method)
1186         * Bio::Search::Hit::HitI
1187          - hsps() method returns list of all HSPs (next_hsp is an
1188            iterator method)
1190     o The Bio::SearchIO::Writer classes have been fixed to handle results
1191        created from either psiblast (Search::BlastXX objects) or
1192        blast|fasta|blastxml objects (Search::GenericXX objects).  More work
1193        has to be done here to make it work properly and will nee major
1194        API changes.
1196     o Bugs in Bio::Tools::HMMER fixed, including
1197        * #1178 - Root::IO destructor wasn't being called
1198        * #1034 - filter_on_cutoff now behaves properly
1200     o Bio::SeqFeature::Computation initialization args fixed and
1201       tests added.
1203     o Tests are somewhat cleaner, flat.t now properly cleans up after itsself,
1205     o Updated FAQ with more example based answers to typical questions
1207     o Bug #1202 was fixed which would improperly join together qual values
1208       parsed by Bio::SeqIO::qual when a trailing space was not present before
1209       the newline.
1211 1.0.0 Major Stable Release
1213   This represents a major release of bioperl with significant
1214   improvements over the 0.7.x series of releases.
1216     o Bio::Tools::Blast is officially deprecated.  Please see
1217       Bio::SearchIO for BLAST and FastA parsing.
1219     o The methods trunc() and subseq() in Bio::PrimarySeqI now accepts
1220       Bio::LocationI objects as well as start/end.
1222     o Bio::Biblio contains modules for Bibliographic data.
1223       Bio::DB::Biblio contains the query modules.  Additionally one can
1224       parse medlinexml from the ebi bibliographic query service (BQS)
1225       system and Pubmed xml from NCBI.  See Martin Senger's
1226       documentation in Bio::Biblio for more information.
1228     o Bio::DB::Registry is a sequence database registry part of
1229       Open Bioinformatics Database Access.  See
1230       http://obda.open-bio.org for more information.
1232     o File-based and In-Memory Sequence caching is provided by
1233       Bio::DB::InMemoryCache and Bio::DB::FileCache which acts like a
1234       local database.
1236     o Bio::Graphics for rendering sequences as PNG,JPG, or GIFs has
1237       been added by Lincoln Stein.
1239     o XEMBL SOAP service access in provided in Bio::DB::XEMBL.
1241     o A FAQ has been started and is included in the release to provide
1242       a starting point for frequent questions and issues.
1244 0.9.3 Developer's release
1246     o Event based parsing system improved (SearchIO).  With parsers for
1247       XML Blast (blastxml), Text Blast (blast), and FASTA results (fasta).
1248       Additionally a lazy parsing system for text and html blast reports was
1249       added and is called psiblast (name subject to change in future releases).
1251     o Bio::Search objects improved and standardized with associated Interfaces
1252       written.  The concept of a search "Hit" was standardized to be called
1253       "hit" consistently and the use of "subject" was deprecated in all active
1254       modules.
1256     o Bio::Structure added (since 0.9.1) for Protein structure objects
1257       and PDB parser to retrieve and write these structures from data files.
1259     o Several important Bio::DB::GFF bug fixes for handling features that
1260       are mapped to multiple reference points.  Updated mysql adaptor
1261       so as to be able to store large (>100 megabase) chunks of DNA into
1262       Bio::DB::GFF databases.
1264 0.9.2 Developer's release
1266     o Bio::Search and Bio::SearchIO system introduced for event based
1267       parsing of Blast,Fasta reports Bio::SearchIO supports ncbi BLAST
1268       in text and XML and FASTA reports in standard output format.
1270     o Bio::Tree and Bio::TreeIO for phylogenetic trees.  A Random tree
1271       generator is included in Bio::TreeIO::RandomTrees and a
1272       statistics module for evaluating.
1274     o Bio::DB::GFF, Lincoln Stein's GFF database suitable as a DB
1275       server for DAS servers.
1277     o Bio::Tools::BPlite is provides more robust parsing of BLAST
1278       files.  The entire BPlite system migrated to using Bio::Root::IO
1279       for the data stream.
1281     o Bio::Tools::Alignment for Consed and sequence Trimming
1282       functionality.
1284     o Bio::Structure for Protein structure information and parsing
1286     o Bio::DB::GenBank/Bio::DB::GenPept updated to new NCBI Entrez
1287       cgi-bin entry point which should be more reliable.
1289     o Bio::Map and Bio::MapIO for biological map navigation and a
1290       framework afor parsing them in.  Only preliminary work here.
1292     o Interface for executing EMBOSS programs locally in Bio::Factory::EMBOSS
1293       Future work will integrate Pise and allow submission of analysis on
1294       remote servers.
1296     o Bio::AnnotationCollectionI and Bio::Annotation::Collection
1297       introduced as new objects for handling Sequence Annotation
1298       information (dblinks, references, etc) and is more robust that
1299       previous system.
1301     o Bio::Tools::FASTAParser introduced.
1303     o Scripts from the bioperl script submission project and new
1304       scripts from bioperl authors are included in "scripts" directory.
1306     o Factory objects and interfaces are being introduced and are more
1307       strictly enforced.
1309     o Bio::Root::Root introduced as the base object while
1310       Bio::Root::RootI is now simply an interface.
1312     o Bio::DB::RefSeq provides database access to copy of the NCBI
1313       RefSeq database using the EBI dbfetch script.
1315 0.9.0 Developer's release
1317     o perl version at least 5.005 is now required instead of perl 5.004
1319     o Bio::Tools::Run::RemoteBlast is available for running remote
1320       blast jobs at NCBI.
1322     o Bio::Tools::BPbl2seq was fixed to handle multiple HSPs.
1324     o Bio::SeqFeature::GeneStructure migrated to Bio::SeqFeature::Gene.
1325       Also added are related modules UTR3, UTR5, Exon, Intron,
1326       Promotor, PolyA and Transcript.
1328     o Speedup of translate method in PrimarySeq
1330     o Bio::SimpleAlign has new methods: location_from_column(), slice(),
1331       select(), dot(), get_seq_by_pos(), column_from_residue_number()
1333     o Various fixes to Variation toolkit
1335     o Bio::DB::EMBL provides database access to EMBL sequence data.
1336       Bio::DB::Universal provides a central way to point to indexes
1337       and dbs in a single interface.
1339     o Bio::DB::GFF - a database suitable for running DAS servers locally.
1341     o Bio::Factory::EMBOSS is still in design phase as is
1342       Bio::Factory::ApplicationFactoryI
1344     o Dia models for bioperl design are provided in the models/ directory
1346 0.7.2 Bug fix release
1348     o documentation fixes in many modules - SYNOPSIS code verified
1349       to be runnable in many (but not all modules)
1351     o corrected MANIFEST file from 0.7.1 release
1353     o Bug fix in Bio::SeqIO::FTHelper to properly handle
1354       split locations
1356     o Bio::SeqIO::genbank
1357         * Correct parsing and writing of genbank format with protein data
1358         * moltype and molecule separation
1360     o Bio::SeqIO::largefasta fix to avoid inifinite loops
1362     o Bio::SimpleAlign fixed to correctly handle consensus
1363       sequence calculation
1365     o Bio::Tools::HMMER supports hmmer 2.2g
1367     o Bio::Tools::BPlite to support report type specific parsing.  Most
1368       major changes are not on the 0.7 branch.
1370     o Bio::Tools::Run::StandAloneBlast exists_blast() fixed and works
1371       with File::Spec
1373     o Bio::Variation::AAChange/RNAChange corrected labels and mutated alleles
1374         in several types of mutations:
1375         1.) AA level: deletion, complex
1376         2.) AA level: complex, inframe
1377         3.) RNA level: silent
1379     o  BPbl2seq parsing of empty reports will not die, but will return
1380        a valid, empty, Bio::SeqFeature::SimilarityFeature for
1381        $report->query() and $report->subject() methods.  So an easy
1382        way to test if report was empty is to see if
1383        $report->query->seqname is undefined.
1385 0.7.1 Bug fix release
1387     o Better parsing of genbank/EMBL files especially fixing bugs
1388       related to Feature table parsing and locations on remote
1389       sequences.  Additionally, species name parsing was better.
1391     o Bio::SeqIO::genbank can parse now NCBI produced genbank database
1392       which include a number of header lines.
1394     o More strict genbank and EMBL format writing (corrected number of
1395       spaces where appropriate).
1397     o Bio::Tools::BPlite can better parse BLASTX reports - see BUGS
1398       for related BPlite BUGS that are unresolved in this release.
1400     o Bio::DB::GenBank, Bio::DB::GenPept have less problems
1401       downloading sequences from NCBI via HTTP.  Bio::DB::SwissProt can
1402       use expasy mirrors or EBI dbfetch cgi-script.
1404     o A moderate number of documentation improvements were made as
1405       well to provide a better code synopsis in each module.
1408 0.7  Large number of changes, including refactoring of the
1409      Object system, new parsers, new functionality and
1410      all round better system. Highlights are:
1413      o Refactored root of inheritance: moved to a lightweight Bio::Root::RootI;
1414        Bio::Root::IO for I/O and file/handle capabilities.
1416      o Imported BPlite modules from Ian Korf for BLAST
1417        parsing. This is considered the supported BLAST parser;
1418        Bio::Tools::Blast.pm will eventually phase out due to lack of support.
1420      o Improved Sequence Feature model. Added complete location
1421        modelling (with fuzzy and compound locations).  See
1422        Bio::LocationI and the modules under Bio/Location.  Added
1423        support in Genbank/EMBL format parsing to completely parse
1424        feature tables for complex locations.
1426      o Moved special support for databanks etc to specialized modules under
1427        Bio/Seq/. One of these supports very large sequences through
1428        a temporary file as a backend.
1430      o Explicit Gene, Transcript and Exon SeqFeature objects, supporting
1431        CDS retrieval and exon shuffling.
1433      o More parsers: Sim4, Genscan, MZEF, ESTScan, BPbl2seq, GFF
1435      o Refactored Bio/DB/GenBank+GenPept. There is now also DB/SwissProt and
1436        DB/GDB (the latter has platform-specific limitations).
1438      o New analysis parser framework for HT sequence annotation (see
1439        Bio::SeqAnalysisParserI and Bio::Factory::SeqAnalysisParserFactory)
1441      o New Alignment IO framework
1443      o New Index modules (Swissprot)
1445      o New modules for running Blast within perl
1446        (Bio::Tools::Run::StandAloneBlast). Added modules for running
1447        Multiple Sequence Alignment tools ClustalW and TCoffee
1448        (Bio::Tools::Run::Alignment).
1450      o New Cookbook-style tutorial (see bptutorial.pl). Improved
1451        documentation across the package.
1453      o Much improved cross platform support. Many known incompatibilities
1454        have been fixed; however, NT and Mac do not work across the entire
1455        setup (see PLATFORMS).
1457      o Many bug fixes, code restructuring, etc. Overall stability and
1458        maintainability benefit a lot.
1460      o A total of 957 automatic tests
1463 0.6.2
1465    There are very few functionality changes but a large
1466    number of software improvements/bug fixes across the package.
1468    o The EMBL/GenBank parsing are improved.
1470    o The Swissprot reading is improved. Swissprot writing
1471      is disabled as it doesn't work at all. This needs to
1472      wait for 0.7 release
1474    o BLAST reports with no hits are correctly parsed.
1476    o Several other bugs of the BLAST parser (regular expressions, ...)
1477      fixed.
1479    o Old syntax calls have been replaced with more modern syntax
1481    o Modules that did not work at all, in particular the Sim4
1482      set have been removed
1484    o Bio::SeqFeature::Generic and Bio::SeqFeature::FeaturePair
1485      have improved compliance with interface specs and documentation
1487    o Mailing list documentation updated throughout the distribution
1489    o Most minor bug fixes have happened.
1491    o The scripts in /examples now work and have the modern syntax
1492      rather than the deprecated syntax
1495 0.6.1  Sun April 2 2000
1497    o Sequences can have Sequence Features attached to them
1498         - The sequence features can be read from or written to
1499           EMBL and GenBank style flat files
1501    o Objects for Annotation, including References (but not
1502      full medline abstracts), Database links and Comments are
1503      provided
1505    o A Species object to represent nodes on a taxonomy tree
1506      is provided
1508    o The ability to parse HMMER and Sim4 output has been added
1510    o The Blast parsing has been improved, with better PSI-BLAST
1511      support and better overall behaviour.
1513    o Flat file indexed databases provide both random access
1514      and sequential access to their component sequences.
1516    o A CodonTable object has been written with all known
1517      CodonTables accessible.
1519    o A number of new lightweight analysis tools have been
1520      added, such as molecular weight determination.
1522     The 0.6 release also has improved software engineering
1524    o The sequence objects have been rewritten, providing more
1525      maintainable and easier to implement objects. These
1526      objects are backwardly compatible with the 0.05.1 objects
1528    o Many objects are defined in terms of interfaces and then
1529      a Perl implementation has been provided. The interfaces
1530      are found in the 'I' files (module names ending in 'I').
1532      This means that it is possible to wrap C/CORBA/SQL access
1533      as true "bioperl" objects, compatible with the rest of
1534      bioperl.
1536    o The SeqIO system has been overhauled to provide better
1537      processing and perl-like automatic interpretation of <>
1538      over arguments.
1540    o Many more tests have been added (a total of 172 automatic
1541      tests are now run before release).
1545 0.05.1 Tue Jun 29 05:30:44 1999
1546         - Central distribution now requires Perl 5.004. This was
1547           done to get around 5.003-based problems in Bio/Index/*
1548           and SimpleAlign.
1549         - Various bug fixes in the Bio::Tools::Blast modules
1550           including better exception handling and PSI-Blast
1551           support. See Bio/Tools/Blast/CHANGES for more.
1552         - Fixed the Parse mechanism in Seq.pm to use readseq.
1553           Follow the instructions in README for how to install
1554           it (basically, you have to edit Parse.pm).
1555         - Improved documentation of Seq.pm, indicating where
1556           objects are returned and where strings are returned.
1557         - Fixed uninitialized warnings in Bio::Root::Object.pm
1558           and Bio::Tools::SeqPattern.pm.
1559         - Bug fixes for PR#s: 30,31,33-35,41,42,44,45,47-50,52.
1561 0.05  Sun Apr 25 01:14:11 1999
1562         - Bio::Tools::Blast modules have less memory problems
1563           and faster parsing. Webblast uses LWP and supports
1564           more functionality. See Bio/Tools/Blast/CHANGES for more.
1565         - The Bio::SeqIO system has been started, moving the
1566           sequence reformatting code out of the sequence object
1567         - The Bio::Index:: system has been started, providing
1568           generic index capabilities and specifically works for
1569           Fasta formatted databases and EMBL .dat formatted
1570           databases
1571         - The Bio::DB:: system started, providing access to
1572           databases, both via flat file + index (see above) and
1573           via http to NCBI
1574         - The scripts/ directory, where industrial strength scripts
1575           are put has been started.
1576         - Many changes - a better distribution all round.
1578 0.04.4  Wed Feb 17 02:20:13 1999
1579         - Bug fixes in the Bio::Tools::Blast modules and postclient.pl
1580           (see Bio::Tools::Blast::CHANGES).
1581         - Fixed a bug in Bio::Tools::Fasta::num_seqs().
1582         - Beefed up the t/Fasta.t test script.
1583         - Small fix in Bio::Seq::type() (now always returns a string).
1584         - Changed Bio::Root::Utilities::get_newline_char() to
1585           get_newline() since it could return more than one char.
1586         - Added $NEWLINE and $TIMEOUT_SECS to Bio::Root::Global.
1587         - Changed default timeout to 20 seconds (was 3).
1588         - Moved lengthy modification notes to the bottom of some files.
1589         - Fixed SimpleAlign write_fasta bug.
1590         - Beefed up SimpleAlign.t test
1592 0.04.3  Thu Feb  4 07:48:53 1999
1593         - Bio::Root::Object.pm and Global.pm now detect when
1594           script is run as a CGI and suppress output that is only
1595           appropriate when running interactively.
1596         - Bio::Root::Err::_set_context() adds name of script ($0).
1597         - Added comments in Bio::Tools::WWW.pm and Bio::Root::Utilities.pm
1598           regarding the use of the static objects via the qw(:obj) tag.
1599         - Fixed the ambiguous reverse calls in Seq.pm and UnivAln.pm to
1600           CORE::reverse, avoiding Perl warnings.
1601         - Bug fixes in Bio::Tools::Blast modules (version 0.074) and
1602           example scripts (see Bio::Tools::Blast::CHANGES).
1603         - examples/seq/seqtools.pl no longer always warns about using
1604           -prot or -nucl command-line arguments; only when using the
1605           -debug argument.
1606         - Methods added to Bio::Root::Utilities: create_filehandle(),
1607           get_newline_char(), and taste_file() to generalize filehandle
1608           creation and autodetect newline characters in files/streams
1609           (see bug report #19).
1610         - Bio::Root::IOManager::read() now handles timeouts and uses
1611           Utilities::create_filehandle().
1612         - Bio::Tools::Fasta.pm uses Utilities::get_newline_char() instead
1613           of hardwiring in "\n".
1614         - Bug fixes in the Bio::SimpleAlign and Bio::Tools::pSW
1616 0.04.2  Wed Dec 30 02:27:36 1998
1617         - Bug fixes in Bio::Tools::Blast modules, version 0.073
1618           (see Bio::Tools::Blast::CHANGES).
1619         - Changed reverse calls in Bio/Seq.pm and Bio/UnivAln.pm
1620           to CORE::reverse (prevents ambiguous warnings with 5.005).
1621         - Appending '.tmp.bioperl' to temporary files created by
1622           Bio::Root::Utilities::compress() or uncompress() to
1623           make it easy to identify & cleanup these files as needed.
1624         - Developers: Created CVS branch release-0-04-bug from
1625           release-0-04-1. Before making bug fixes to the 0.04.1 release,
1626           be sure to cvs checkout this branch into a clean area.
1628 0.04.1  Wed Dec 16 05:39:15 1998
1629         - Bug fixes in Bio::Tools::Blast modules, version 0.072
1630           (see Bio::Tools::Blast::CHANGES).
1631         - Compile/SW/Makefile.PL now removes *.o and *.a files
1632           with make clean.
1634 0.04  Tue Dec  8 07:49:19 1998
1635         - Lots of new modules added including:
1636            * Ewan Birney's Bio::SimpleAlign.pm, Bio::Tools::AlignFactory.pm,
1637              and Bio/Compile directory containing XS-linked C code for
1638              creating Smith-Waterman sequence alignments from within Perl.
1639            * Steve Chervitz's Blast distribution has been incorporated.
1640            * Georg Fuellen's Bio::UnivAln.pm for multiple alignment objects.
1641         - Bio/examples directory for demo scripts for all included modules.
1642         - Bio/t directory containing test suit for all included modules.
1643         - For changes specific to the Blast-related modules prior to
1644           incorporation in this central distribution, see the CHANGES
1645           file in the Bio/Tools/Blast directory.
1647 0.01  Tue Sep  8 14:23:22 1998
1648         - original version from central CVS tree; created by h2xs 1.18