README

   1 # $Id$
   2
   3 bioperl-network README
   4
   5 1. Installation
   6 2. Introduction
   7 3. Status
   8 4. History
   9
  10
  11 1. Installation
  12
  13 See the accompanying INSTALL file for details on installing
  14 bioperl-network.
  15
  16
  17 2. Introduction
  18
  19 A ProteinNet is a representation of a protein-protein interaction network.
  20 Its functionality derives from the Graph module of Perl and from BioPerl.
  21 These sorts of networks, or graphs, can be modeled as nodes, or
  22 vertices, connected by edges.
  23
  24 A node is one or more BioPerl sequence objects, a Bio::Seq or
  25 Bio::Seq::RichSeq object. Since a node can contain more than one
  26 Sequence object it can represent protein complexes as well as proteins.
  27 Essentially the node can be any Bioperl object that implements the
  28 Bio::AnnotatableI and Bio::IdentifiableI interfaces. This is relevant since the
  29 identities of nodes are determined by their identifiers.
  30
  31 The bioperl-network modules use Perl's Graph::Undirected
  32 module and inherit its formal model as well. An edge corresponds to a
  33 pair of nodes, and there is only one edge per pair. An interaction is an
  34 attribute of an edge, and there can be 1 or more interactions per edge.
  35 An interaction can be thought of as one experiment or one experimental
  36 observation.
  37
  38 The formats that can be parsed are DIP (tab-delimited) and PSI MI
  39 (XML), either version 1 or version 2.5. Capabilities include the
  40 ability to merge networks, select nodes and interactions by
  41 identifier, add and delete components (nodes, interactions, and
  42 edges), count all components of a certain type, get all components of
  43 a certain type, and get subgraphs. Then you have all the functionality
  44 of Perl's Graph in addition such as traversal using different
  45 algorithms, getting interior and exterior nodes, and getting all
  46 connected subgraphs. Graph is quite rich in functionality, this list
  47 is only a small subset of available methods, see the documentation
  48 for Graph for more detail (http://search.cpan.org/~jhi/Graph/lib/Graph.pod).
  49
  50 For more detailed documentation also see the
  51 Bio::Network::ProteinNet module.
  52
  53
  54 3. Status
  55
  56 This package should be considered a preliminary piece of
  57 work. Although the code is tested and stable it lacks functionality. Not
  58 all fields in the PSI MI standard are parsed into a network, for example.
  59 The BioPAX format is not parsed, arguably as important a format as
  60 PSI MI. In addition useful functions such as searching by sequence or
  61 ontology term aren't yet implemented. If you are interested in contributing
  62 please contact Brian Osborne at bioperl-l@bioperl.org.
  63
  64
  65 4. History
  66
  67 Modules similar to these were first released as part of the core BioPerl package
  68 and were called Bio::Graph*. Bio::Graph was copied to a separate package,
  69 bioperl-network, and renamed Bio::Network. All of the modules were
  70 revised and a new module, Interaction.pm, was added. The
  71 functionality of the PSI MI 1.0 parser was enhanced and a version
  72 2.5 parser was added.
  73
  74 Graph manipulation in the predecessor Bio::Graph was based on the
  75 Bio::Graph::SimpleGraph module by Nat Goodman. The first release as a
  76 separate package, bioperl-network, replaced SimpleGraph with the Perl
  77 Graph package. Other API changes were also made, partly to keep
  78 nomenclature consistent with BioPerl, partly to use the terms used by
  79 the public protein interaction databases, and partly to accommodate the
  80 differences between Graph and Bio::Graph::SimpleGraph.
  81
  82 The advantages to using Graph are that Bioperl developers are not
  83 responsible for maintaining the code that actually handles graph
  84 manipulation and there is more functionality in Graph than in SimpleGraph.
  85 You must install version .86 of Graph, or greater.