Christopher Fields > BioPerl-1.6.922 > Bio::Factory::AnalysisI

Download:
BioPerl-1.6.922.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  12
Open  4
View/Report Bugs
Module Version: 1.006922   Source   Latest Release: BioPerl-1.6.924

NAME ^

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

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.

FEEDBACK ^

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 ^

Martin Senger (martin.senger@gmail.com)

COPYRIGHT ^

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.

DISCLAIMER ^

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

SEE ALSO ^

APPENDIX ^

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.

syntax highlighting: