Bio::Factory AnalysisI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvsRaw content
Summary
Bio::Factory::AnalysisI - An interface to analysis tool factory
Package variables
No package variables defined.
Included modules
Bio::Root::RootI
Inherit
Bio::Root::RootI
Synopsis
This is an interface module - you do not instantiate it.
Use Bio::Tools::Run::AnalysisFactory module:
  use Bio::Tools::Run::AnalysisFactory;
  my $list = new Bio::Tools::Run::AnalysisFactory->available_analyses;
Description
This interface contains all public methods for showing available
analyses and for creating objects representing them.
Methods
BEGIN Code
available_analysesDescriptionCode
available_categoriesDescriptionCode
create_analysisDescriptionCode
Methods description
available_analysescode    nextTop
 Usage   : $factory->available_analyses;
           $factory->available_analyses ($category);
 Returns : an array reference with the names of
           all available analyses, or the analyses
           available in the given '$category'
 Args    : none || category_name
Show available analyses. Their names usually consist of category
analysis names, separated by ::.
available_categoriescodeprevnextTop
 Usage   : $factory->available_categories;
 Returns : an array reference with the names of
           available categories
 Args    : none
The analysis tools may be grouped into categories by their functional
similarity, or by the similar data types they deal with. This method
shows all available such categories.
create_analysiscodeprevnextTop
 Usage   : $factory->create_analysis ($name);
 Returns : a Bio::Tools::Run::Analyis object
 Args    : analysis name
A real factory method creating an analysis object. The created
object gets all access and location information from the factory
object.
Methods code
BEGINTop
BEGIN {
    $Revision = q$$Id: AnalysisI.pm,v 1.2.2.1 2003/07/04 02:40:29 shawnh Exp $;
}
available_analysesdescriptionprevnextTop
sub available_analyses {
 shift->throw_not_implemented();
}
available_categoriesdescriptionprevnextTop
sub available_categories {
 shift->throw_not_implemented();
}
create_analysisdescriptionprevnextTop
sub create_analysis {
 shift->throw_not_implemented();
}
General documentation
FEEDBACKTop
Mailing ListsTop
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
  bioperl-l@bioperl.org              - General discussion
  http://bioperl.org/MailList.shtml  - About the mailing lists
Reporting BugsTop
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
email or the web:
  bioperl-bugs@bioperl.org
  http://bioperl.org/bioperl-bugs/
AUTHORTop
Martin Senger (senger@ebi.ac.uk)
COPYRIGHTTop
Copyright (c) 2003, Martin Senger and EMBL-EBI.
All Rights Reserved.
This module is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
DISCLAIMERTop
This software is provided "as is" without warranty of any kind.
SEE ALSOTop
    *
http://industry.ebi.ac.uk/soaplab/Perl_Client.html
APPENDIXTop
This is actually the main documentation...
If you try to call any of these methods directly on this
Bio::Factory::AnalysisI object you will get a not implemented
error message. You need to call them on a
Bio::Tools::Run::AnalysisFactory object instead.