Bio::Factory::AnalysisI - An interface to analysis tool factory


BioPerl documentation Contained in the BioPerl distribution.

Index


Code Index:

NAME

Top

Bio::Factory::AnalysisI - An interface to analysis tool factory

SYNOPSIS

Top

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

Top

This interface contains all public methods for showing available analyses and for creating objects representing them.

FEEDBACK

Top

Mailing Lists

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

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 Bugs

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/

AUTHOR

Top

Martin Senger (martin.senger@gmail.com)

COPYRIGHT

Top

DISCLAIMER

Top

This software is provided "as is" without warranty of any kind.

SEE ALSO

Top

APPENDIX

Top

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.

available_categories

 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_analyses

 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_analysis

 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.


BioPerl documentation Contained in the BioPerl distribution.
#
# BioPerl module for Bio::Factory::AnalysisI
#
# Please direct questions and support issues to <bioperl-l@bioperl.org> 
#
# Cared for by Martin Senger <martin.senger@gmail.com>
# For copyright and disclaimer see below.
#

# POD documentation - main docs before the code


# Let the code begin...

package Bio::Factory::AnalysisI;
use strict;

use base qw(Bio::Root::RootI);


# -----------------------------------------------------------------------------

sub available_categories { shift->throw_not_implemented(); }

# -----------------------------------------------------------------------------

sub available_analyses { shift->throw_not_implemented(); }

# -----------------------------------------------------------------------------

sub create_analysis { shift->throw_not_implemented(); }

# -----------------------------------------------------------------------------


1;
__END__