← Back to branch summary

~ubuntu-branches/ubuntu/precise/bioperl/precise

« back to all changes in this revision

Viewing changes to Bio/AnalysisI.pm

  • Committer: Bazaar Package Importer
  • Author(s): Ilya Barygin
  • Date: 2010-01-27 22:48:22 UTC
  • mfrom: (3.1.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100127224822-ebot4qbrjxcv38au
Tags: 1.6.1-1ubuntu1
* Merge from Debian testing, remaining changes:
  - disable tests, they produce a FTBFS trying to access the network 
    during run.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Bio/AnalysisI.pm
1
 
# $Id: AnalysisI.pm 11480 2007-06-14 14:16:21Z sendu $
 
1
# $Id: AnalysisI.pm 16147 2009-09-22 01:26:32Z cjfields $
2
2
#
3
3
# BioPerl module for Bio::AnalysisI
4
4
#
 
5
# Please direct questions and support issues to <bioperl-l@bioperl.org> 
 
6
#
5
7
# Cared for by Martin Senger <martin.senger@gmail.com>
6
8
# For copyright and disclaimer see below.
7
9
#
37
39
  bioperl-l@bioperl.org                  - General discussion
38
40
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
39
41
 
 
42
=head2 Support 
 
43
 
 
44
Please direct usage questions or support issues to the mailing list:
 
45
 
 
46
I<bioperl-l@bioperl.org>
 
47
 
 
48
rather than to the module maintainer directly. Many experienced and 
 
49
reponsive experts will be able look at the problem and quickly 
 
50
address it. Please include a thorough description of the problem 
 
51
with code and data examples if at all possible.
 
52
 
40
53
=head2 Reporting Bugs
41
54
 
42
55
Report bugs to the Bioperl bug tracking system to help us keep track
63
76
 
64
77
=head1 SEE ALSO
65
78
 
66
 
L<http://www.ebi.ac.uk/soaplab/Perl_Client.html>.
 
79
http://www.ebi.ac.uk/Tools/webservices/soaplab/guide
67
80
 
68
81
=head1 APPENDIX
69
82
 
185
198
The analysis input data are named, and can be also associated with a
186
199
default value, with allowed values and with few other attributes. The
187
200
names are important for feeding the service with the input data (the
188
 
inputs are given to methods C<create_job>, C<run>, and/or C<wait_for>
189
 
as name/value pairs).
 
201
inputs are given to methods C<create_job>, C<Bio::AnalysisI|run>, and/or
 
202
C<Bio::AnalysisI|wait_for> as name/value pairs).
190
203
 
191
204
Here is a (slightly shortened) example of an input specification:
192
205
 
311
324
 
312
325
Call this method if you wish to "stage the scene" - to create a job
313
326
with all input data but without actually running it. This method is
314
 
called automatically from other methods (C<run> and C<wait_for>) so
315
 
usually you do not need to call it directly.
 
327
called automatically from other methods (C<Bio::AnalysisI|run> and
 
328
C<Bio::AnalysisI|wait_for>) so usually you do not need to call it directly.
316
329
 
317
330
The input data and prameters for this execution can be specified in
318
331
various ways:
446
459
 
447
460
# -----------------------------------------------------------------------------
448
461
 
449
 
=head2 run
 
462
=head2 Bio::AnalysisI::JobI::run
450
463
 
451
464
 Usage   : $job->run
452
465
 Returns : itself
454
467
 
455
468
It starts previously created job.  The job already must have all input
456
469
data filled-in. This differs from the method of the same name of the
457
 
C<Bio::Tools::Run::Analysis> object where the C<run> method creates
458
 
also a new job allowing to set input data.
 
470
C<Bio::Tools::Run::Analysis> object where the C<Bio::AnalysisI::JobI::run> method
 
471
creates also a new job allowing to set input data.
459
472
 
460
473
=cut
461
474
 
463
476
 
464
477
# -----------------------------------------------------------------------------
465
478
 
466
 
=head2 wait_for
 
479
=head2 Bio::AnalysisI::JobI::wait_for
467
480
 
468
481
 Usage   : $job->wait_for
469
482
 Returns : itself