bioperl.pod

   1 ## $Id: bioperl.pod,v 1.36 2002-08-26 12:36:04 bosborne Exp $
   2
   3 ## Should contain general info about the distribution including
   4 ## links to many modules.
   5 ##
   6 ## 'cookbook' type examples are probably better off being placed
   7 ## in the local embedded module PODs. This will make it easier for
   8 ## authors to update and maintain.
   9
  10 =head1 NAME
  11
  12 Bioperl - Coordinated OOP-Perl Modules for Biology
  13
  14 =head1 SYNOPSIS
  15
  16 Read on...
  17
  18
  19 =head1 DESCRIPTION
  20
  21 Bioperl contains a number of Perl objects which are useful in biology.
  22 Examples include Sequence objects, Alignment objects and database
  23 searching objects. These objects not only do what they are advertised
  24 to do in the documentation, but they also interact - Alignment
  25 objects are made from the Sequence objects, Sequence objects have access
  26 to Annotation and SeqFeature objects and databases, Blast objects can be
  27 converted to Alignment objects, and so on. This means that the objects
  28 provide a coordinated and extensible framework to do computational biology.
  29
  30 Bioperl development is focused on the Perl modules or objects themselves.
  31 There are scripts provided in the scripts/ directory but scripts are
  32 not the main focus of the Bioperl developers. Of course, as the
  33 objects do most of the hard work for you, all you have to do is combine a
  34 number of objects together sensibly to make useful scripts.
  35
  36 The intent of the Bioperl development effort is to make reusable tools
  37 that aid people in creating their own sites or job-specific applications.
  38
  39 The bioperl.org website at http://bioperl.org also attempts to maintain
  40 links and archives of standalone bio-related Perl tools that are not
  41 affiliated or related to the core Bioperl effort. Check the site for
  42 useful code ideas and contribute your own if possible.
  43
  44
  45 =head1 DOCUMENTATION
  46
  47 We have a cookbook tutorial in bptutorial.pl which has embedded
  48 documentation. Start there if learning-by-example suits you most, or
  49 examine the Bioperl online course at
  50 http://www.pasteur.fr/recherche/unites/sis/formation/bioperl. Make sure
  51 to check the documentation in the modules as well - there are over 500
  52 modules in Bioperl, and counting, and there's detail in the modules'
  53 documentation that will not appear in the general documentation.
  54
  55
  56 =head1 INSTALLATION
  57
  58 The Bioperl modules are distributed as a tar file that expands into a
  59 standard perl CPAN distribution.  Detailed installation directions
  60 can be found in the distribution INSTALL file.
  61
  62 The Bioperl modules can now interact with local flat file and relational
  63 databases. To learn how to set this up, look at the biodatabases.pod
  64 documentation ('perldoc biodatabases.pod' should work once Bioperl has
  65 been installed).
  66
  67 The bioperl-db, bioperl-gui, corba-server, bioperl-pipeline and
  68 corba-client packages are installed separately from Bioperl. Please
  69 refer to their respective documentation for more information.
  70
  71
  72 =head1 GETTING STARTED
  73
  74 A good place to start is by reading and running the cookbook script,
  75 bptutorial.pl.
  76
  77 The distribution I<scripts/> directory has working scripts for use
  78 with Bioperl. A list and brief description of these scripts is found
  79 in bioscripts.pod. You are more than welcome to contribute your script!
  80
  81 If you have installed Bioperl in the standard way, as detailed in the
  82 README in the distribution, these scripts should work by just running
  83 them. If you have not installed it in a standard way you will
  84 have to change the 'use lib' to point to your installation (see INSTALL
  85 for details).
  86
  87
  88 =head1 GETTING INVOLVED
  89
  90 Bioperl is a completely open community of developers. We are not
  91 funded and we don't have a mission statement. We encourage
  92 collaborative code, in particular in Perl. You can help us in many
  93 different ways, from just a simple statement about how you have used
  94 Bioperl to doing something interesting to contributing a whole new object
  95 hierarchy. See http://bioperl.org for more information. Here are
  96 some ways of helping us:
  97
  98 =head2 Asking questions and telling us you used it
  99
 100 We are very interested to hear how you experienced using Bioperl. Did
 101 it install cleanly? Did you understand the documentation? Could you
 102 get the objects to do what you wanted them to do? If Bioperl was useless
 103 we want to know why, and if it was great - that too. Post a message to
 104 bioperl-l@bioperl.org, the Bioperl mailing list, where all the developers
 105 are.
 106
 107 Only by getting people's feedback do we know whether we are providing
 108 anything useful.
 109
 110 =head2 Writing a script that uses it
 111
 112 By writing a good script that uses Bioperl you both show that Bioperl
 113 is useful and probably save someone elsewhere writing it. If you
 114 contribute it to the 'script central' at http://bioperl.org then other
 115 people can view and use it. Don't be nervous if you've never done this
 116 sort of work, advice is freely given and all are welcome!
 117
 118 =head2 Find bugs!
 119
 120 We know that there are bugs in there. If you find something which you are
 121 pretty sure is a problem, post a note to bioperl-bugs@bioperl.org and
 122 we will get on it as soon as possible. You can also access the bug
 123 system through the web pages.
 124
 125 =head2 Suggest new functionality
 126
 127 You can suggest areas where the objects are not ideally written and
 128 could be done better. The best way is to find the main developer
 129 of the module (each module was written principally by one person,
 130 except for Seq.pm). Talk to him or her and suggest changes.
 131
 132 =head2 Make your own objects
 133
 134 If you can make a useful object we will happily include it into the
 135 core. Probably you will want to read a lot of the documentation
 136 in the L<Bio::Root>, talk to people on the Bioperl mailing list,
 137 bioperl-l@bioperl.org, and read biodesign.pod. biodesign.pod provides
 138 documentation on the conventions and ideas used in Bioperl, it's definitely
 139 worth a read if you would like to be a Bioperl developer.
 140
 141
 142 =head1 ACKNOWLEDGEMENTS
 143
 144 Bioperl owes its early organizational support to its association with
 145 the award-winning VSNS-BCD BioComputing Courses; some students of the
 146 1996 course (Chris Dagdigian, Richard Resnick, Lew Gramer, Alessandro
 147 Guffanti, and others) have contributed code and commentary. Georg
 148 Fuellen, the VSNS-BCD chief organizer was one of the early driving forces
 149 behind Bioperl. Steven Brenner, who was an early adopter of Perl for
 150 bioinformatics provided some of the early work on Bioperl. Lincoln Stein
 151 has long provided guidance and code.
 152
 153 Bioperl was then taken up by people developing code at the large
 154 genome centres. In particular Steve Chervitz at Stanford, Ian Korf at
 155 the Genome Sequencing Centre (St. Louis) and Ewan Birney at the Sanger
 156 Centre (Cambridge UK).  All of the C code XS extensions were
 157 provided by Ewan Birney. Bioperl is used in anger at these sites,
 158 indicating that is both useful and that it works.
 159
 160 Jason Stajich and Hilmar Lapp joined Bioperl for the drive towards a
 161 0.7 release over 2000 and the first part of 2001, which includes a
 162 revised feature location model, richer feature objects (in particular
 163 genes) and more and better tools. Peter Schattner and Lorenz Pollak
 164 contributed serious chunks of code, being the AlignIO and bptutorial
 165 scripts and the BPLite port to Bioperl respectively. At this time
 166 Bioperl was being used in absolute earnest by the Ensembl group which
 167 shook out a number of problems in the code base. Additional
 168 compatibility with the Sequence Workbench (Bioperl-gui, Mark
 169 Wilkinson and David Block) and Biocorba (Jason Stajich, Brad Chapman
 170 and Alan Robinson) and finally Game-XML (Brad Marshall) provided more
 171 interoperability.
 172
 173 Current server hardware for bioperl.org (and other open-bio.org hosted
 174 projects) was provided by Compaq Computer Corporation.  The donation
 175 was facilitated by both the Pharmaceutical Sales and High Performance
 176 Technical Computing (HPTC) groups.
 177
 178 The Bioperl servers reside in Cambridge, Massachusetts USA with
 179 colocation facilities and Internet bandwidth donated by Genetics
 180 Institute. In particular Dr. Steven Howes, Kenny Grant &
 181 Rich DiNunno have made significant efforts on our behalf.
 182
 183
 184 =head1 COPYRIGHT
 185
 186  Copyright (c) 1996-2000 Georg Fuellen, Richard Resnick, Steven E. Brenner,
 187  Chris Dagdigian, Steve Chervitz, Ewan Birney, James Gilbert, Elia Stupka,
 188  and others. All Rights Reserved. This module is free software;
 189  you can redistribute it and/or modify it under the same terms as Perl itself.
 190
 191 =cut