lib/CXGN/Cluster.pm

   1
   2 =head1 NAME
   3
   4 CXGN::Cluster classes
   5
   6 =head1 DESCRIPTION
   7
   8 The CXGN::Cluster classes help keep track of clusters of sequences, assemble new clusters from data such as blast reports, and output clusters in multi-fasta files etc.
   9
  10 'use'ing this file will pull in CXGN::Cluster::Object, CXGN::Cluster::Precluster, and CXGN::Cluster::ClusterSet.
  11
  12 =head2 Notes on the classes:
  13
  14 =over 5
  15
  16 =item L<CXGN::Cluster::Object>
  17
  18 the base object of the CXGN::Cluster classes. Essentially contains the set_debug and debug functions, which are inherited by all classes.
  19
  20 =item L<CXGN::Cluster::ClusterSet>
  21
  22 represents a set of preclusters.
  23
  24 =item L<CXGN::Cluster::Precluster>
  25
  26 represents a cluster composed of sequence members. Only the IDs are stored.
  27
  28
  29 =back
  30
  31 =head1 AUTHOR
  32
  33 Lukas Mueller <lam87@cornell.edu>
  34
  35 =cut
  36
  37 use CXGN::Cluster::Object;
  38 use CXGN::Cluster::Precluster;
  39 use CXGN::Cluster::ClusterSet;
  40
  41
  42
  43
  44 return 1;