1
# $Id: filtersites.pm,v 1.6 2006/07/04 22:23:34 mauricio Exp $
2
# BioPerl module for Bio::Tools::Run::PiseApplication::filtersites
4
# Cared for by Catherine Letondal <letondal@pasteur.fr>
6
# For copyright and disclaimer see below.
8
# POD documentation - main docs before the code
12
Bio::Tools::Run::PiseApplication::filtersites
20
Bio::Tools::Run::PiseApplication::filtersites
24
filtersites Filter conserved sites in an alignment (K. Schuerer)
30
http://bioweb.pasteur.fr/seqanal/interfaces/filtersites.html
31
for available values):
50
Phylip weights file rather than filtered alignment (for parsimony programs only) (-w)
53
Phylip alignment output format
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.
63
bioperl-l@bioperl.org - General discussion
64
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
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
72
http://bugzilla.open-bio.org/
76
Catherine Letondal (letondal@pasteur.fr)
80
Copyright (C) 2003 Institut Pasteur & Catherine Letondal.
83
This module is free software; you can redistribute it and/or modify
84
it under the same terms as Perl itself.
88
This software is provided "as is" without warranty of any kind.
96
http://bioweb.pasteur.fr/seqanal/interfaces/filtersites.html
100
Bio::Tools::Run::PiseApplication
104
Bio::Tools::Run::AnalysisFactory::Pise
108
Bio::Tools::Run::PiseJob
115
package Bio::Tools::Run::PiseApplication::filtersites;
119
use Bio::Tools::Run::PiseApplication;
121
@ISA = qw(Bio::Tools::Run::PiseApplication);
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');
133
Returns : An instance of Bio::Tools::Run::PiseApplication::filtersites.
138
my ($class, $location, $email, @params) = @_;
139
my $self = $class->SUPER::new($location, $email);
141
# -- begin of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/filtersites.pm
143
$self->{COMMAND} = "filtersites";
144
$self->{VERSION} = "5.a";
145
$self->{TITLE} = "filtersites";
147
$self->{DESCRIPTION} = "Filter conserved sites in an alignment";
149
$self->{OPT_EMAIL} = 0;
151
$self->{CATEGORIES} = [
153
"alignment:multiple",
156
$self->{AUTHORS} = "K. Schuerer";
158
$self->{_INTERFACE_STANDOUT} = undef;
159
$self->{_STANDOUT_FILE} = undef;
161
$self->{TOP_PARAMETERS} = [
172
$self->{PARAMETERS_ORDER} = [
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
184
"filtersites" => 'String',
185
"outalig" => 'OutFile',
186
"outweights" => 'OutFile',
187
"infile" => 'Sequence',
188
"threshold" => 'Float',
189
"weights" => 'Switch',
190
"phylip_alig" => 'Switch',
196
"perl" => '"filtersites"',
201
"perl" => '" > weights.out"',
204
"perl" => '" $value"',
207
"perl" => '(defined $value && $value != $vdef) ? " -t $value" : ""',
210
"perl" => '(defined $value && $value) ? " -w" : ""',
213
"perl" => ' ($value)? " | readseq -p -f12 " : ""',
218
$self->{FILENAMES} = {
233
"phylip_alig" => 100,
237
$self->{BY_GROUP_PARAMETERS} = [
252
$self->{ISHIDDEN} = {
263
$self->{ISCOMMAND} = {
274
$self->{ISMANDATORY} = {
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",
296
$self->{ISSTANDOUT} = {
315
$self->{SEPARATOR} = {
320
"outalig" => '"filtersites.out"',
321
"outweights" => '"weights.out"',
322
"threshold" => '1.0',
324
"phylip_alig" => '1',
329
"filtersites" => { "perl" => '1' },
331
"perl" => '! $weights',
334
"perl" => '$weights',
336
"infile" => { "perl" => '1' },
337
"threshold" => { "perl" => '1' },
338
"weights" => { "perl" => '1' },
340
"perl" => '! $weights',
351
'1' => "readseq_ok_alig",
354
'1' => "phylip_weights",
359
$self->{WITHPIPEOUT} = {
361
"phylip_weights" => ["infile",]
368
"readseq_ok_alig" => '1',
373
$self->{WITHPIPEIN} = {
388
$self->{ISSIMPLE} = {
399
$self->{PARAMFILE} = {
407
$self->{SCALEMIN} = {
411
$self->{SCALEMAX} = {
415
$self->{SCALEINC} = {
423
# -- end of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/filtersites.pm
427
$self->_init_params(@params);
434
1; # Needed to keep compiler happy