~ubuntu-branches/ubuntu/wily/bioperl-run/wily-proposed

« back to all changes in this revision

Viewing changes to Bio/Tools/Run/PiseApplication/filtersites.pm

  • Committer: Bazaar Package Importer
  • Author(s): Charles Plessy
  • Date: 2009-09-03 11:00:03 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20090903110003-11of27rxner5vnl9
Tags: 1.6.1-1
* New upstream release.
* debian/patches/10-wrong-path-for-interpreter.patch: removed
  (fixed upstream).
* debian/watch updated (bioperl -> BioPerl).
* debian/rules refreshed with dh-make-perl 0.53.
  - Disabled installation of examples (removed upstream).
  - Removed the correction of file permission of Pise documentation
    (removed upstream).
  - Removed patching facilities (no patches anymore).
  - Disabled tests as I experience failures with t/Eponine.t despite
    this program is not installed.
* debian/copyright:
  - Removed vanity lines about debianization and debian copyright.
  - Incremented years to 2009.
  - Updated to latest experimentation of the machine-readable license summary.
* debian/control:
  - Incremented Standards-Version to reflect conformance on new Policy
    (dropped versionned build-dependancy on Perl).
  - Removed build-dependancy on quilt (no patches anymore).
  - Depend and Build-Depend on bioperl versions superior or equal to 1.6.0.
  - Build-depends on, and Recommdnes libalgorithm-diff-perl, libipc-run-perl,
    libio-string-perl and libxml-twig-perl, that are listed in DEPENDANCIES.
  - Build-depends on libarray-compare-perl and libtree-dagnode-perl
    (otherwise tests fail). 
  - Depend on amap-align instead of amap (Closes: #541274).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# $Id: filtersites.pm,v 1.6 2006/07/04 22:23:34 mauricio Exp $
2
 
# BioPerl module for Bio::Tools::Run::PiseApplication::filtersites
3
 
#
4
 
# Cared for by Catherine Letondal <letondal@pasteur.fr>
5
 
#
6
 
# For copyright and disclaimer see below.
7
 
#
8
 
# POD documentation - main docs before the code
9
 
 
10
 
=head1 NAME
11
 
 
12
 
Bio::Tools::Run::PiseApplication::filtersites
13
 
 
14
 
=head1 SYNOPSIS
15
 
 
16
 
  #
17
 
 
18
 
=head1 DESCRIPTION
19
 
 
20
 
Bio::Tools::Run::PiseApplication::filtersites
21
 
 
22
 
      Bioperl class for:
23
 
 
24
 
        filtersites     Filter conserved sites in an alignment (K. Schuerer)
25
 
 
26
 
 
27
 
      Parameters: 
28
 
 
29
 
        (see also:
30
 
          http://bioweb.pasteur.fr/seqanal/interfaces/filtersites.html 
31
 
         for available values):
32
 
 
33
 
 
34
 
                filtersites (String)
35
 
 
36
 
                outalig (OutFile)
37
 
                        pipe: readseq_ok_alig
38
 
 
39
 
                outweights (OutFile)
40
 
                        pipe: phylip_weights
41
 
 
42
 
                infile (Sequence)
43
 
                        Alignment
44
 
                        pipe: readseq_ok_alig
45
 
 
46
 
                threshold (Float)
47
 
                        Threshold (-t)
48
 
 
49
 
                weights (Switch)
50
 
                        Phylip weights file rather than filtered alignment (for parsimony programs only) (-w)
51
 
 
52
 
                phylip_alig (Switch)
53
 
                        Phylip alignment output format
54
 
 
55
 
=head1 FEEDBACK
56
 
 
57
 
=head2 Mailing Lists
58
 
 
59
 
User feedback is an integral part of the evolution of this and other
60
 
Bioperl modules. Send your comments and suggestions preferably to
61
 
the Bioperl mailing list.  Your participation is much appreciated.
62
 
 
63
 
  bioperl-l@bioperl.org                  - General discussion
64
 
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
65
 
 
66
 
=head2 Reporting Bugs
67
 
 
68
 
Report bugs to the Bioperl bug tracking system to help us keep track
69
 
of the bugs and their resolution. Bug reports can be submitted via the
70
 
web:
71
 
 
72
 
  http://bugzilla.open-bio.org/
73
 
 
74
 
=head1 AUTHOR
75
 
 
76
 
Catherine Letondal (letondal@pasteur.fr)
77
 
 
78
 
=head1 COPYRIGHT
79
 
 
80
 
Copyright (C) 2003 Institut Pasteur & Catherine Letondal.
81
 
All Rights Reserved.
82
 
 
83
 
This module is free software; you can redistribute it and/or modify
84
 
it under the same terms as Perl itself.
85
 
 
86
 
=head1 DISCLAIMER
87
 
 
88
 
This software is provided "as is" without warranty of any kind.
89
 
 
90
 
=head1 SEE ALSO
91
 
 
92
 
=over
93
 
 
94
 
=item *
95
 
 
96
 
http://bioweb.pasteur.fr/seqanal/interfaces/filtersites.html
97
 
 
98
 
=item *
99
 
 
100
 
Bio::Tools::Run::PiseApplication
101
 
 
102
 
=item *
103
 
 
104
 
Bio::Tools::Run::AnalysisFactory::Pise
105
 
 
106
 
=item *
107
 
 
108
 
Bio::Tools::Run::PiseJob
109
 
 
110
 
=back
111
 
 
112
 
=cut
113
 
 
114
 
#'
115
 
package Bio::Tools::Run::PiseApplication::filtersites;
116
 
 
117
 
use vars qw(@ISA);
118
 
use strict;
119
 
use Bio::Tools::Run::PiseApplication;
120
 
 
121
 
@ISA = qw(Bio::Tools::Run::PiseApplication);
122
 
 
123
 
=head2 new
124
 
 
125
 
 Title   : new()
126
 
 Usage   : my $filtersites = Bio::Tools::Run::PiseApplication::filtersites->new($location, $email, @params);
127
 
 Function: Creates a Bio::Tools::Run::PiseApplication::filtersites object.
128
 
           This method should not be used directly, but rather by 
129
 
           a Bio::Tools::Run::AnalysisFactory::Pise instance.
130
 
           my $factory = Bio::Tools::Run::AnalysisFactory::Pise->new();
131
 
           my $filtersites = $factory->program('filtersites');
132
 
 Example : -
133
 
 Returns : An instance of Bio::Tools::Run::PiseApplication::filtersites.
134
 
 
135
 
=cut
136
 
 
137
 
sub new {
138
 
    my ($class, $location, $email, @params) = @_;
139
 
    my $self = $class->SUPER::new($location, $email);
140
 
 
141
 
# -- begin of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/filtersites.pm
142
 
 
143
 
    $self->{COMMAND}   = "filtersites";
144
 
    $self->{VERSION}   = "5.a";
145
 
    $self->{TITLE}   = "filtersites";
146
 
 
147
 
    $self->{DESCRIPTION}   = "Filter conserved sites in an alignment";
148
 
 
149
 
    $self->{OPT_EMAIL}   = 0;
150
 
 
151
 
    $self->{CATEGORIES}   =  [  
152
 
 
153
 
         "alignment:multiple",
154
 
  ];
155
 
 
156
 
    $self->{AUTHORS}   = "K. Schuerer";
157
 
 
158
 
    $self->{_INTERFACE_STANDOUT} = undef;
159
 
    $self->{_STANDOUT_FILE} = undef;
160
 
 
161
 
    $self->{TOP_PARAMETERS}  = [ 
162
 
        "filtersites",
163
 
        "outalig",
164
 
        "outweights",
165
 
        "infile",
166
 
        "threshold",
167
 
        "weights",
168
 
        "phylip_alig",
169
 
 
170
 
    ];
171
 
 
172
 
    $self->{PARAMETERS_ORDER}  = [
173
 
        "filtersites",
174
 
        "outalig",
175
 
        "outweights",
176
 
        "infile",       # Alignment
177
 
        "threshold",    # Threshold (-t)
178
 
        "weights",      # Phylip weights file rather than filtered alignment (for parsimony programs only) (-w)
179
 
        "phylip_alig",  # Phylip alignment output format
180
 
 
181
 
    ];
182
 
 
183
 
    $self->{TYPE}  = {
184
 
        "filtersites" => 'String',
185
 
        "outalig" => 'OutFile',
186
 
        "outweights" => 'OutFile',
187
 
        "infile" => 'Sequence',
188
 
        "threshold" => 'Float',
189
 
        "weights" => 'Switch',
190
 
        "phylip_alig" => 'Switch',
191
 
 
192
 
    };
193
 
 
194
 
    $self->{FORMAT}  = {
195
 
        "filtersites" => {
196
 
                "perl" => '"filtersites"',
197
 
        },
198
 
        "outalig" => {
199
 
        },
200
 
        "outweights" => {
201
 
                "perl" => '" > weights.out"',
202
 
        },
203
 
        "infile" => {
204
 
                "perl" => '" $value"',
205
 
        },
206
 
        "threshold" => {
207
 
                "perl" => '(defined $value && $value != $vdef) ? " -t $value" : ""',
208
 
        },
209
 
        "weights" => {
210
 
                "perl" => '(defined $value && $value) ? " -w" : ""',
211
 
        },
212
 
        "phylip_alig" => {
213
 
                "perl" => ' ($value)? " | readseq -p -f12 " : ""',
214
 
        },
215
 
 
216
 
    };
217
 
 
218
 
    $self->{FILENAMES}  = {
219
 
 
220
 
    };
221
 
 
222
 
    $self->{SEQFMT}  = {
223
 
        "infile" => [8],
224
 
 
225
 
    };
226
 
 
227
 
    $self->{GROUP}  = {
228
 
        "filtersites" => 0,
229
 
        "outweights" => 100,
230
 
        "infile" => 10,
231
 
        "threshold" => 2,
232
 
        "weights" => 3,
233
 
        "phylip_alig" => 100,
234
 
 
235
 
    };
236
 
 
237
 
    $self->{BY_GROUP_PARAMETERS}  = [
238
 
        "filtersites",
239
 
        "outalig",
240
 
        "threshold",
241
 
        "weights",
242
 
        "infile",
243
 
        "outweights",
244
 
        "phylip_alig",
245
 
 
246
 
    ];
247
 
 
248
 
    $self->{SIZE}  = {
249
 
 
250
 
    };
251
 
 
252
 
    $self->{ISHIDDEN}  = {
253
 
        "filtersites" => 1,
254
 
        "outalig" => 1,
255
 
        "outweights" => 1,
256
 
        "infile" => 0,
257
 
        "threshold" => 0,
258
 
        "weights" => 0,
259
 
        "phylip_alig" => 0,
260
 
 
261
 
    };
262
 
 
263
 
    $self->{ISCOMMAND}  = {
264
 
        "filtersites" => 1,
265
 
        "outalig" => 0,
266
 
        "outweights" => 0,
267
 
        "infile" => 0,
268
 
        "threshold" => 0,
269
 
        "weights" => 0,
270
 
        "phylip_alig" => 0,
271
 
 
272
 
    };
273
 
 
274
 
    $self->{ISMANDATORY}  = {
275
 
        "filtersites" => 0,
276
 
        "outalig" => 0,
277
 
        "outweights" => 0,
278
 
        "infile" => 1,
279
 
        "threshold" => 0,
280
 
        "weights" => 0,
281
 
        "phylip_alig" => 0,
282
 
 
283
 
    };
284
 
 
285
 
    $self->{PROMPT}  = {
286
 
        "filtersites" => "",
287
 
        "outalig" => "",
288
 
        "outweights" => "",
289
 
        "infile" => "Alignment",
290
 
        "threshold" => "Threshold (-t)",
291
 
        "weights" => "Phylip weights file rather than filtered alignment (for parsimony programs only) (-w)",
292
 
        "phylip_alig" => "Phylip alignment output format",
293
 
 
294
 
    };
295
 
 
296
 
    $self->{ISSTANDOUT}  = {
297
 
        "filtersites" => 0,
298
 
        "outalig" => 1,
299
 
        "outweights" => 0,
300
 
        "infile" => 0,
301
 
        "threshold" => 0,
302
 
        "weights" => 0,
303
 
        "phylip_alig" => 0,
304
 
 
305
 
    };
306
 
 
307
 
    $self->{VLIST}  = {
308
 
 
309
 
    };
310
 
 
311
 
    $self->{FLIST}  = {
312
 
 
313
 
    };
314
 
 
315
 
    $self->{SEPARATOR}  = {
316
 
 
317
 
    };
318
 
 
319
 
    $self->{VDEF}  = {
320
 
        "outalig" => '"filtersites.out"',
321
 
        "outweights" => '"weights.out"',
322
 
        "threshold" => '1.0',
323
 
        "weights" => '0',
324
 
        "phylip_alig" => '1',
325
 
 
326
 
    };
327
 
 
328
 
    $self->{PRECOND}  = {
329
 
        "filtersites" => { "perl" => '1' },
330
 
        "outalig" => {
331
 
                "perl" => '! $weights',
332
 
        },
333
 
        "outweights" => {
334
 
                "perl" => '$weights',
335
 
        },
336
 
        "infile" => { "perl" => '1' },
337
 
        "threshold" => { "perl" => '1' },
338
 
        "weights" => { "perl" => '1' },
339
 
        "phylip_alig" => {
340
 
                "perl" => '! $weights',
341
 
        },
342
 
 
343
 
    };
344
 
 
345
 
    $self->{CTRL}  = {
346
 
 
347
 
    };
348
 
 
349
 
    $self->{PIPEOUT}  = {
350
 
        "outalig" => {
351
 
                 '1' => "readseq_ok_alig",
352
 
        },
353
 
        "outweights" => {
354
 
                 '1' => "phylip_weights",
355
 
        },
356
 
 
357
 
    };
358
 
 
359
 
    $self->{WITHPIPEOUT}  = {
360
 
        "outweights" => {
361
 
                 "phylip_weights" => ["infile",]
362
 
        },
363
 
 
364
 
    };
365
 
 
366
 
    $self->{PIPEIN}  = {
367
 
        "infile" => {
368
 
                 "readseq_ok_alig" => '1',
369
 
        },
370
 
 
371
 
    };
372
 
 
373
 
    $self->{WITHPIPEIN}  = {
374
 
 
375
 
    };
376
 
 
377
 
    $self->{ISCLEAN}  = {
378
 
        "filtersites" => 0,
379
 
        "outalig" => 0,
380
 
        "outweights" => 0,
381
 
        "infile" => 0,
382
 
        "threshold" => 0,
383
 
        "weights" => 0,
384
 
        "phylip_alig" => 0,
385
 
 
386
 
    };
387
 
 
388
 
    $self->{ISSIMPLE}  = {
389
 
        "filtersites" => 0,
390
 
        "outalig" => 0,
391
 
        "outweights" => 0,
392
 
        "infile" => 1,
393
 
        "threshold" => 0,
394
 
        "weights" => 0,
395
 
        "phylip_alig" => 1,
396
 
 
397
 
    };
398
 
 
399
 
    $self->{PARAMFILE}  = {
400
 
 
401
 
    };
402
 
 
403
 
    $self->{COMMENT}  = {
404
 
 
405
 
    };
406
 
 
407
 
    $self->{SCALEMIN}  = {
408
 
 
409
 
    };
410
 
 
411
 
    $self->{SCALEMAX}  = {
412
 
 
413
 
    };
414
 
 
415
 
    $self->{SCALEINC}  = {
416
 
 
417
 
    };
418
 
 
419
 
    $self->{INFO}  = {
420
 
 
421
 
    };
422
 
 
423
 
# -- end of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/filtersites.pm
424
 
 
425
 
 
426
 
 
427
 
    $self->_init_params(@params);
428
 
 
429
 
    return $self;
430
 
}
431
 
 
432
 
 
433
 
 
434
 
1; # Needed to keep compiler happy
435