Bio::Factory AnalysisI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Toolbar
WebCvs
Summary
Bio::Factory::AnalysisI - An interface to analysis tool factory
Package variables
No package variables defined.
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 = Bio::Tools::Run::AnalysisFactory->new->available_analyses;
Description
This interface contains all public methods for showing available
analyses and for creating objects representing them.
Methods
available_categoriesDescriptionCode
available_analysesDescriptionCode
create_analysisDescriptionCode
Methods description
available_categoriescode    nextTop
 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.
available_analysescodeprevnextTop
 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 ::.
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
available_categoriesdescriptionprevnextTop
sub available_categories {
 shift->throw_not_implemented();
}
available_analysesdescriptionprevnextTop
sub available_analyses {
 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/wiki/Mailing_lists  - About the mailing lists
Support Top
Please direct usage questions or support issues to the mailing list:
bioperl-l@bioperl.org
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
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 the
web:
  https://redmine.open-bio.org/projects/bioperl/
AUTHORTop
Martin Senger (martin.senger@gmail.com)
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://www.ebi.ac.uk/Tools/webservices/soaplab/guide
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.