|
0
|
1 # $Id: AnalysisI.pm,v 1.2.2.1 2003/07/04 02:40:29 shawnh Exp $
|
|
|
2 #
|
|
|
3 # BioPerl module for Bio::Factory::AnalysisI
|
|
|
4 #
|
|
|
5 # Cared for by Martin Senger <senger@ebi.ac.uk>
|
|
|
6 # For copyright and disclaimer see below.
|
|
|
7 #
|
|
|
8
|
|
|
9 # POD documentation - main docs before the code
|
|
|
10
|
|
|
11 =head1 NAME
|
|
|
12
|
|
|
13 Bio::Factory::AnalysisI - An interface to analysis tool factory
|
|
|
14
|
|
|
15 =head1 SYNOPSIS
|
|
|
16
|
|
|
17 This is an interface module - you do not instantiate it.
|
|
|
18 Use I<Bio::Tools::Run::AnalysisFactory> module:
|
|
|
19
|
|
|
20 use Bio::Tools::Run::AnalysisFactory;
|
|
|
21 my $list = new Bio::Tools::Run::AnalysisFactory->available_analyses;
|
|
|
22
|
|
|
23 =head1 DESCRIPTION
|
|
|
24
|
|
|
25 This interface contains all public methods for showing available
|
|
|
26 analyses and for creating objects representing them.
|
|
|
27
|
|
|
28 =head1 FEEDBACK
|
|
|
29
|
|
|
30 =head2 Mailing Lists
|
|
|
31
|
|
|
32 User feedback is an integral part of the evolution of this and other
|
|
|
33 Bioperl modules. Send your comments and suggestions preferably to
|
|
|
34 the Bioperl mailing list. Your participation is much appreciated.
|
|
|
35
|
|
|
36 bioperl-l@bioperl.org - General discussion
|
|
|
37 http://bioperl.org/MailList.shtml - About the mailing lists
|
|
|
38
|
|
|
39 =head2 Reporting Bugs
|
|
|
40
|
|
|
41 Report bugs to the Bioperl bug tracking system to help us keep track
|
|
|
42 of the bugs and their resolution. Bug reports can be submitted via
|
|
|
43 email or the web:
|
|
|
44
|
|
|
45 bioperl-bugs@bioperl.org
|
|
|
46 http://bioperl.org/bioperl-bugs/
|
|
|
47
|
|
|
48 =head1 AUTHOR
|
|
|
49
|
|
|
50 Martin Senger (senger@ebi.ac.uk)
|
|
|
51
|
|
|
52 =head1 COPYRIGHT
|
|
|
53
|
|
|
54 Copyright (c) 2003, Martin Senger and EMBL-EBI.
|
|
|
55 All Rights Reserved.
|
|
|
56
|
|
|
57 This module is free software; you can redistribute it and/or modify
|
|
|
58 it under the same terms as Perl itself.
|
|
|
59
|
|
|
60 =head1 DISCLAIMER
|
|
|
61
|
|
|
62 This software is provided "as is" without warranty of any kind.
|
|
|
63
|
|
|
64 =head1 SEE ALSO
|
|
|
65
|
|
|
66 =over
|
|
|
67
|
|
|
68 =item *
|
|
|
69
|
|
|
70 http://industry.ebi.ac.uk/soaplab/Perl_Client.html
|
|
|
71
|
|
|
72 =back
|
|
|
73
|
|
|
74 =head1 APPENDIX
|
|
|
75
|
|
|
76 This is actually the main documentation...
|
|
|
77
|
|
|
78 If you try to call any of these methods directly on this
|
|
|
79 C<Bio::Factory::AnalysisI> object you will get a I<not implemented>
|
|
|
80 error message. You need to call them on a
|
|
|
81 C<Bio::Tools::Run::AnalysisFactory> object instead.
|
|
|
82
|
|
|
83 =cut
|
|
|
84
|
|
|
85
|
|
|
86 # Let the code begin...
|
|
|
87
|
|
|
88 package Bio::Factory::AnalysisI;
|
|
|
89 use vars qw(@ISA $Revision);
|
|
|
90 use strict;
|
|
|
91 use Bio::Root::RootI;
|
|
|
92
|
|
|
93 @ISA = qw(Bio::Root::RootI);
|
|
|
94
|
|
|
95 BEGIN {
|
|
|
96 $Revision = q$Id: AnalysisI.pm,v 1.2.2.1 2003/07/04 02:40:29 shawnh Exp $;
|
|
|
97 }
|
|
|
98
|
|
|
99
|
|
|
100 # -----------------------------------------------------------------------------
|
|
|
101
|
|
|
102 =head2 available_categories
|
|
|
103
|
|
|
104 Usage : $factory->available_categories;
|
|
|
105 Returns : an array reference with the names of
|
|
|
106 available categories
|
|
|
107 Args : none
|
|
|
108
|
|
|
109 The analysis tools may be grouped into categories by their functional
|
|
|
110 similarity, or by the similar data types they deal with. This method
|
|
|
111 shows all available such categories.
|
|
|
112
|
|
|
113 =cut
|
|
|
114
|
|
|
115 sub available_categories { shift->throw_not_implemented(); }
|
|
|
116
|
|
|
117 # -----------------------------------------------------------------------------
|
|
|
118
|
|
|
119 =head2 available_analyses
|
|
|
120
|
|
|
121 Usage : $factory->available_analyses;
|
|
|
122 $factory->available_analyses ($category);
|
|
|
123 Returns : an array reference with the names of
|
|
|
124 all available analyses, or the analyses
|
|
|
125 available in the given '$category'
|
|
|
126 Args : none || category_name
|
|
|
127
|
|
|
128 Show available analyses. Their names usually consist of category
|
|
|
129 analysis names, separated by C<::>.
|
|
|
130
|
|
|
131 =cut
|
|
|
132
|
|
|
133 sub available_analyses { shift->throw_not_implemented(); }
|
|
|
134
|
|
|
135 # -----------------------------------------------------------------------------
|
|
|
136
|
|
|
137 =head2 create_analysis
|
|
|
138
|
|
|
139 Usage : $factory->create_analysis ($name);
|
|
|
140 Returns : a Bio::Tools::Run::Analyis object
|
|
|
141 Args : analysis name
|
|
|
142
|
|
|
143 A real I<factory> method creating an analysis object. The created
|
|
|
144 object gets all access and location information from the factory
|
|
|
145 object.
|
|
|
146
|
|
|
147 =cut
|
|
|
148
|
|
|
149 sub create_analysis { shift->throw_not_implemented(); }
|
|
|
150
|
|
|
151 # -----------------------------------------------------------------------------
|
|
|
152
|
|
|
153
|
|
|
154 1;
|
|
|
155 __END__
|
|
|
156
|
