README

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