1
# $Id: clustalw.pm,v 1.6 2006/07/04 22:23:34 mauricio Exp $
2
# BioPerl module for Bio::Tools::Run::PiseApplication::clustalw
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::clustalw
20
Bio::Tools::Run::PiseApplication::clustalw
24
Clustalw Multiple Alignments (Des Higgins)
28
Thompson, J.D., Higgins, D.G. and Gibson, T.J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple sequence alignment through sequence weighting, positions-specific gap penalties and weight matrix choice. Nucleic Acids Research, 22:4673-4680.
35
http://bioweb.pasteur.fr/seqanal/interfaces/clustalw.html
36
for available values):
42
Sequences File (or Alignment File for Bootstrap and Tree actions) (-infile)
50
Phylip alignment output format (-output)
53
Toggle Slow/Fast pairwise alignments (-quicktree)
56
Protein or DNA (-type)
59
Protein weight matrix (-matrix)
62
DNA weight matrix (-dnamatrix)
65
Gap opening penalty (-gapopen)
68
Gap extension penalty (-gapext)
71
End gap separation penalty (-endgaps)
74
Gap separation pen. range (-gapdist)
77
Residue specific penalties (Pascarella gaps) (-nopgap)
80
Hydrophilic gaps (-nohgap)
83
Hydrophilic residues list (-hgapresidues)
86
Delay divergent sequences : % ident. for delay (-maxdiv)
89
Negative values in matrix ? (-negative)
92
Transitions weight (between 0 and 1) (-transweight)
95
File for new guide tree (-newtree)
98
File for old guide tree (-usetree)
104
Number of best diagonals (-topdiags)
107
Window around best diags (-window)
110
Gap penalty (-pairgap)
113
Percent or absolute score ? (-score)
116
Protein weight matrix (-pwmatrix)
119
DNA weight matrix (-pwdnamatrix)
122
Gap opening penalty (-pwgapopen)
125
Gap extension penalty (-pwgapext)
128
Use Kimura's correction (multiple substitutions) ? (-kimura)
131
Ignore positions with gaps ? (-tossgaps)
134
Bootstrap a NJ tree (give the number of bootstraps, 0 for none) (-bootstrap)
137
Phylip bootstrap positions (-bootlabels)
140
Seed number for bootstraps (-seed)
143
Output tree/distance format (-outputtree)
146
Alignment File (-outfile)
147
pipe: readseq_ok_alig
150
Output format (-output)
153
Upper case GDE output (-case)
156
Result order (-outorder)
159
Output sequence numbers in the output file (clustalw format) (-seqnos)
162
Profile 1 (-profile1)
165
Profile 2 (-profile2)
168
File for old guide tree for profile1 (-usetree1)
171
File for old guide tree for profile2 (-usetree2)
174
File for new guide tree for profile1 (-newtree1)
177
File for new guide tree for profile2 (-newtree2)
180
Use profile 1 secondary structure / penalty mask (-nosecstr1)
183
Use profile 2 secondary structure / penalty mask (-nosecstr2)
186
Helix gap penalty (-helixgap)
189
Strand gap penalty (-strandgap)
192
Loop gap penalty (-loopgap)
194
terminalgap (Integer)
195
Secondary structure terminal penalty (-terminalgap)
198
Helix terminal positions: number of residues inside helix to be treated as terminal (-helixendin)
200
helixendout (Integer)
201
Helix terminal positions: number of residues outside helix to be treated as terminal (-helixendout)
203
strandendin (Integer)
204
Strand terminal positions: number of residues inside strand to be treated as terminal (-strandendin)
206
strandendout (Integer)
207
Strand terminal positions: number of residues outside strand to be treated as terminal (-strandendout)
210
Output in alignment (-secstrout)
216
User feedback is an integral part of the evolution of this and other
217
Bioperl modules. Send your comments and suggestions preferably to
218
the Bioperl mailing list. Your participation is much appreciated.
220
bioperl-l@bioperl.org - General discussion
221
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
223
=head2 Reporting Bugs
225
Report bugs to the Bioperl bug tracking system to help us keep track
226
of the bugs and their resolution. Bug reports can be submitted via the
229
http://bugzilla.open-bio.org/
233
Catherine Letondal (letondal@pasteur.fr)
237
Copyright (C) 2003 Institut Pasteur & Catherine Letondal.
240
This module is free software; you can redistribute it and/or modify
241
it under the same terms as Perl itself.
245
This software is provided "as is" without warranty of any kind.
253
http://bioweb.pasteur.fr/seqanal/interfaces/clustalw.html
257
Bio::Tools::Run::PiseApplication
261
Bio::Tools::Run::AnalysisFactory::Pise
265
Bio::Tools::Run::PiseJob
272
package Bio::Tools::Run::PiseApplication::clustalw;
276
use Bio::Tools::Run::PiseApplication;
278
@ISA = qw(Bio::Tools::Run::PiseApplication);
283
Usage : my $clustalw = Bio::Tools::Run::PiseApplication::clustalw->new($location, $email, @params);
284
Function: Creates a Bio::Tools::Run::PiseApplication::clustalw object.
285
This method should not be used directly, but rather by
286
a Bio::Tools::Run::AnalysisFactory::Pise instance.
287
my $factory = Bio::Tools::Run::AnalysisFactory::Pise->new();
288
my $clustalw = $factory->program('clustalw');
290
Returns : An instance of Bio::Tools::Run::PiseApplication::clustalw.
295
my ($class, $location, $email, @params) = @_;
296
my $self = $class->SUPER::new($location, $email);
298
# -- begin of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/clustalw.pm
300
$self->{COMMAND} = "clustalw";
301
$self->{VERSION} = "5.a";
302
$self->{TITLE} = "Clustalw";
304
$self->{DESCRIPTION} = "Multiple Alignments";
306
$self->{OPT_EMAIL} = 0;
308
$self->{AUTHORS} = "Des Higgins";
310
$self->{REFERENCE} = [
312
"Thompson, J.D., Higgins, D.G. and Gibson, T.J. (1994) CLUSTAL W: improving the sensitivity of progressive multiple sequence alignment through sequence weighting, positions-specific gap penalties and weight matrix choice. Nucleic Acids Research, 22:4673-4680.",
315
$self->{_INTERFACE_STANDOUT} = undef;
316
$self->{_STANDOUT_FILE} = undef;
318
$self->{TOP_PARAMETERS} = [
329
"readseq_ok_aligfile",
337
$self->{PARAMETERS_ORDER} = [
339
"infile", # Sequences File (or Alignment File for Bootstrap and Tree actions) (-infile)
341
"phylip_alig", # Phylip alignment output format (-output)
342
"multalign", # Multiple Alignments parameters
343
"quicktree", # Toggle Slow/Fast pairwise alignments (-quicktree)
344
"typeseq", # Protein or DNA (-type)
345
"matrix", # Protein weight matrix (-matrix)
346
"dnamatrix", # DNA weight matrix (-dnamatrix)
347
"gapopen", # Gap opening penalty (-gapopen)
348
"gapext", # Gap extension penalty (-gapext)
349
"endgaps", # End gap separation penalty (-endgaps)
350
"gapdist", # Gap separation pen. range (-gapdist)
351
"pgap", # Residue specific penalties (Pascarella gaps) (-nopgap)
352
"hgap", # Hydrophilic gaps (-nohgap)
353
"hgapresidues", # Hydrophilic residues list (-hgapresidues)
354
"maxdiv", # Delay divergent sequences : % ident. for delay (-maxdiv)
355
"negative", # Negative values in matrix ? (-negative)
356
"transweight", # Transitions weight (between 0 and 1) (-transweight)
357
"newtree", # File for new guide tree (-newtree)
358
"usetree", # File for old guide tree (-usetree)
359
"fastpw", # Fast Pairwise Alignments parameters
360
"ktuple", # Word size (-ktuple)
361
"topdiags", # Number of best diagonals (-topdiags)
362
"window", # Window around best diags (-window)
363
"pairgap", # Gap penalty (-pairgap)
364
"score", # Percent or absolute score ? (-score)
365
"slowpw", # Slow Pairwise Alignments parameters
366
"pwmatrix", # Protein weight matrix (-pwmatrix)
367
"pwdnamatrix", # DNA weight matrix (-pwdnamatrix)
368
"pwgapopen", # Gap opening penalty (-pwgapopen)
369
"pwgapext", # Gap extension penalty (-pwgapext)
370
"trees", # Tree parameters
371
"kimura", # Use Kimura's correction (multiple substitutions) ? (-kimura)
372
"tossgaps", # Ignore positions with gaps ? (-tossgaps)
373
"bootstrap", # Bootstrap a NJ tree (give the number of bootstraps, 0 for none) (-bootstrap)
374
"bootlabels", # Phylip bootstrap positions (-bootlabels)
375
"seed", # Seed number for bootstraps (-seed)
376
"outputtree", # Output tree/distance format (-outputtree)
377
"outputparam", # Output parameters
378
"outfile", # Alignment File (-outfile)
379
"output", # Output format (-output)
380
"gde_lower", # Upper case GDE output (-case)
381
"outorder", # Result order (-outorder)
382
"seqnos", # Output sequence numbers in the output file (clustalw format) (-seqnos)
384
"readseq_ok_aligfile",
387
"profile", # Profile Alignments parameters
388
"profile1", # Profile 1 (-profile1)
389
"profile2", # Profile 2 (-profile2)
390
"usetree1", # File for old guide tree for profile1 (-usetree1)
391
"usetree2", # File for old guide tree for profile2 (-usetree2)
392
"newtree1", # File for new guide tree for profile1 (-newtree1)
393
"newtree2", # File for new guide tree for profile2 (-newtree2)
394
"structure", # Structure Alignments parameters
395
"nosecstr1", # Use profile 1 secondary structure / penalty mask (-nosecstr1)
396
"nosecstr2", # Use profile 2 secondary structure / penalty mask (-nosecstr2)
397
"helixgap", # Helix gap penalty (-helixgap)
398
"strandgap", # Strand gap penalty (-strandgap)
399
"loopgap", # Loop gap penalty (-loopgap)
400
"terminalgap", # Secondary structure terminal penalty (-terminalgap)
401
"helixendin", # Helix terminal positions: number of residues inside helix to be treated as terminal (-helixendin)
402
"helixendout", # Helix terminal positions: number of residues outside helix to be treated as terminal (-helixendout)
403
"strandendin", # Strand terminal positions: number of residues inside strand to be treated as terminal (-strandendin)
404
"strandendout", # Strand terminal positions: number of residues outside strand to be treated as terminal (-strandendout)
405
"secstrout", # Output in alignment (-secstrout)
410
"clustalw" => 'String',
411
"infile" => 'Sequence',
413
"phylip_alig" => 'Switch',
414
"multalign" => 'Paragraph',
415
"quicktree" => 'Excl',
418
"dnamatrix" => 'Excl',
419
"gapopen" => 'Integer',
421
"endgaps" => 'Switch',
422
"gapdist" => 'Integer',
425
"hgapresidues" => 'List',
426
"maxdiv" => 'Integer',
427
"negative" => 'Switch',
428
"transweight" => 'Float',
429
"newtree" => 'OutFile',
430
"usetree" => 'InFile',
431
"fastpw" => 'Paragraph',
432
"ktuple" => 'Integer',
433
"topdiags" => 'Integer',
434
"window" => 'Integer',
435
"pairgap" => 'Float',
437
"slowpw" => 'Paragraph',
438
"pwmatrix" => 'Excl',
439
"pwdnamatrix" => 'Excl',
440
"pwgapopen" => 'Float',
441
"pwgapext" => 'Float',
442
"trees" => 'Paragraph',
443
"kimura" => 'Switch',
444
"tossgaps" => 'Switch',
445
"bootstrap" => 'Integer',
446
"bootlabels" => 'Excl',
448
"outputtree" => 'Excl',
449
"outputparam" => 'Paragraph',
450
"outfile" => 'OutFile',
452
"gde_lower" => 'Switch',
453
"outorder" => 'Excl',
454
"seqnos" => 'Switch',
455
"aligfile" => 'Results',
456
"readseq_ok_aligfile" => 'Results',
457
"newtreefile" => 'Results',
458
"phylipnewtreefile" => 'Results',
459
"profile" => 'Paragraph',
460
"profile1" => 'InFile',
461
"profile2" => 'InFile',
462
"usetree1" => 'InFile',
463
"usetree2" => 'InFile',
464
"newtree1" => 'OutFile',
465
"newtree2" => 'OutFile',
466
"structure" => 'Paragraph',
467
"nosecstr1" => 'Switch',
468
"nosecstr2" => 'Switch',
469
"helixgap" => 'Integer',
470
"strandgap" => 'Integer',
471
"loopgap" => 'Integer',
472
"terminalgap" => 'Integer',
473
"helixendin" => 'Integer',
474
"helixendout" => 'Integer',
475
"strandendin" => 'Integer',
476
"strandendout" => 'Integer',
477
"secstrout" => 'Excl',
483
"perl" => '"clustalw"',
486
"seqlab" => ' " -infile=value"',
487
"perl" => ' " -infile=$value"',
490
"perl" => ' " $value" ',
493
"perl" => ' ($value)?" -output=PHYLIP":""',
498
"perl" => '($value eq "fast")? " -quicktree" : "" ',
501
"perl" => ' ($value)?" -type=$value":""',
504
"perl" => ' ($value && $value ne $vdef)?" -matrix=$value":""',
507
"perl" => ' ($value && $value ne $vdef)?" -dnamatrix=$value":""',
510
"perl" => ' (defined $value && $value ne $vdef)? " -gapopen=$value" : ""',
513
"perl" => ' (defined $value && $value ne $vdef)? " -gapext=$value" : ""',
516
"perl" => ' (! $value )?" -endgaps":""',
519
"perl" => ' (defined $value && $value != $vdef)? " -gapdist=$value" : ""',
522
"perl" => ' (! $value)?" -nopgap":""',
525
"perl" => ' (! $value)?" -nohgap":""',
528
"perl" => ' ($value && ($value ne $vdef))?" -hgapresidues=\\"$value\\"":""',
531
"perl" => ' (defined $value && $value != $vdef)? " -maxdiv=$value" : ""',
534
"perl" => ' ($value)?" -negative":""',
537
"perl" => ' (defined $value && $value != $vdef)?" -transweight=$value":""',
540
"perl" => ' ($value)? " -newtree=$value" : "" ',
543
"perl" => ' ($value)?" -usetree=$value":""',
548
"perl" => ' (defined $value && $value ne $vdef)?" -ktuple=$value":""',
551
"perl" => ' (defined $value && $value ne $vdef)?" -topdiags=$value":""',
554
"perl" => ' (defined $value && $value ne $vdef)?" -window=$value":""',
557
"perl" => ' (defined $value && $value ne $vdef)?" -pairgap=$value":""',
560
"perl" => ' ($value)?" -score=$value":""',
565
"perl" => ' ($value && $value ne $vdef)?" -pwmatrix=$value":""',
568
"perl" => ' ($value && $value ne $vdef)?" -pwdnamatrix=$value":""',
571
"perl" => ' (defined $value && $value ne $vdef)? " -pwgapopen=$value" : "" ',
574
"perl" => ' (defined $value && $value ne $vdef)? " -pwgapext=$value" : "" ',
579
"perl" => ' ($value)?" -kimura":""',
582
"perl" => ' ($value)?" -tossgaps":""',
585
"perl" => ' ($value > 0 && $value != $vdef)? " -bootstrap=$value":"" ',
588
"perl" => '(defined $value && $value ne $vdef )? " -bootlabels=$value":""',
591
"perl" => ' (defined $value)?" -seed=$value":""',
594
"perl" => ' ($value && $value ne $vdef)?" -outputtree=$value":""',
599
"perl" => ' ($value && $value ne "$infile.aln")?" -outfile=$value":""',
602
"perl" => ' ($value) ?" -output=$value":""',
605
"perl" => '($value) ?" -case=upper":""',
608
"perl" => ' ($value && $value ne $vdef)?" -outorder=$value":""',
611
"perl" => ' ($value) ?" -seqnos=on":""',
615
"readseq_ok_aligfile" => {
619
"phylipnewtreefile" => {
624
"perl" => ' ($value)?" -profile1=$value":""',
627
"perl" => ' ($value)?" -profile2=$value":""',
630
"perl" => ' ($value)?" -usetree1=$value":""',
633
"perl" => ' ($value)?" -usetree2=$value":""',
636
"perl" => ' ($value)? " -newtree1=$value" : "" ',
639
"perl" => ' ($value)? " -newtree2=$value" : "" ',
644
"perl" => '(! $value)? " -nosecstr1" : ""',
647
"perl" => '(! $value)? " -nosecstr2" : ""',
650
"perl" => ' (defined $value && $value != $vdef)? " -helixgap=$value":"" ',
653
"perl" => ' (defined $value && $value != $vdef)? " -strandgap=$value":"" ',
656
"perl" => ' (defined $value && $value != $vdef)? " -loopgap=$value":"" ',
659
"perl" => ' (defined $value && $value != $vdef)? " -terminalgap=$value":"" ',
662
"perl" => ' (defined $value && $value != $vdef)? " -helixendin=$value":"" ',
665
"perl" => ' (defined $value && $value != $vdef)? " -helixendout=$value":"" ',
668
"perl" => ' (defined $value && $value != $vdef)? " -strandendin=$value":"" ',
671
"perl" => ' (defined $value && $value != $vdef)? " -strandendout=$value":"" ',
674
"perl" => '($value && $value ne $vdef)?" -secstrout=$value":""',
679
$self->{FILENAMES} = {
680
"aligfile" => '*.aln *.gde *.phy',
681
"readseq_ok_aligfile" => '*.phy *.msf *.pir',
682
"newtreefile" => '*.nj *.dst',
683
"phylipnewtreefile" => '*.dnd *.ph *.phb',
688
"infile" => [8,3,4,15,100],
760
$self->{BY_GROUP_PARAMETERS} = [
763
"readseq_ok_aligfile",
836
$self->{ISHIDDEN} = {
883
"readseq_ok_aligfile" => 0,
885
"phylipnewtreefile" => 0,
908
$self->{ISCOMMAND} = {
955
"readseq_ok_aligfile" => 0,
957
"phylipnewtreefile" => 0,
980
$self->{ISMANDATORY} = {
1027
"readseq_ok_aligfile" => 0,
1029
"phylipnewtreefile" => 0,
1047
"strandendout" => 0,
1054
"infile" => "Sequences File (or Alignment File for Bootstrap and Tree actions) (-infile)",
1055
"actions" => "Actions",
1056
"phylip_alig" => "Phylip alignment output format (-output)",
1057
"multalign" => "Multiple Alignments parameters",
1058
"quicktree" => "Toggle Slow/Fast pairwise alignments (-quicktree)",
1059
"typeseq" => "Protein or DNA (-type)",
1060
"matrix" => "Protein weight matrix (-matrix)",
1061
"dnamatrix" => "DNA weight matrix (-dnamatrix)",
1062
"gapopen" => "Gap opening penalty (-gapopen)",
1063
"gapext" => "Gap extension penalty (-gapext)",
1064
"endgaps" => "End gap separation penalty (-endgaps)",
1065
"gapdist" => "Gap separation pen. range (-gapdist)",
1066
"pgap" => "Residue specific penalties (Pascarella gaps) (-nopgap)",
1067
"hgap" => "Hydrophilic gaps (-nohgap)",
1068
"hgapresidues" => "Hydrophilic residues list (-hgapresidues)",
1069
"maxdiv" => "Delay divergent sequences : % ident. for delay (-maxdiv)",
1070
"negative" => "Negative values in matrix ? (-negative)",
1071
"transweight" => "Transitions weight (between 0 and 1) (-transweight)",
1072
"newtree" => "File for new guide tree (-newtree)",
1073
"usetree" => "File for old guide tree (-usetree)",
1074
"fastpw" => "Fast Pairwise Alignments parameters",
1075
"ktuple" => "Word size (-ktuple)",
1076
"topdiags" => "Number of best diagonals (-topdiags)",
1077
"window" => "Window around best diags (-window)",
1078
"pairgap" => "Gap penalty (-pairgap)",
1079
"score" => "Percent or absolute score ? (-score)",
1080
"slowpw" => "Slow Pairwise Alignments parameters",
1081
"pwmatrix" => "Protein weight matrix (-pwmatrix)",
1082
"pwdnamatrix" => "DNA weight matrix (-pwdnamatrix)",
1083
"pwgapopen" => "Gap opening penalty (-pwgapopen)",
1084
"pwgapext" => "Gap extension penalty (-pwgapext)",
1085
"trees" => "Tree parameters",
1086
"kimura" => "Use Kimura's correction (multiple substitutions) ? (-kimura)",
1087
"tossgaps" => "Ignore positions with gaps ? (-tossgaps)",
1088
"bootstrap" => "Bootstrap a NJ tree (give the number of bootstraps, 0 for none) (-bootstrap)",
1089
"bootlabels" => "Phylip bootstrap positions (-bootlabels)",
1090
"seed" => "Seed number for bootstraps (-seed)",
1091
"outputtree" => "Output tree/distance format (-outputtree)",
1092
"outputparam" => "Output parameters",
1093
"outfile" => "Alignment File (-outfile)",
1094
"output" => "Output format (-output)",
1095
"gde_lower" => "Upper case GDE output (-case)",
1096
"outorder" => "Result order (-outorder)",
1097
"seqnos" => "Output sequence numbers in the output file (clustalw format) (-seqnos)",
1099
"readseq_ok_aligfile" => "",
1100
"newtreefile" => "",
1101
"phylipnewtreefile" => "",
1102
"profile" => "Profile Alignments parameters",
1103
"profile1" => "Profile 1 (-profile1)",
1104
"profile2" => "Profile 2 (-profile2)",
1105
"usetree1" => "File for old guide tree for profile1 (-usetree1)",
1106
"usetree2" => "File for old guide tree for profile2 (-usetree2)",
1107
"newtree1" => "File for new guide tree for profile1 (-newtree1)",
1108
"newtree2" => "File for new guide tree for profile2 (-newtree2)",
1109
"structure" => "Structure Alignments parameters",
1110
"nosecstr1" => "Use profile 1 secondary structure / penalty mask (-nosecstr1)",
1111
"nosecstr2" => "Use profile 2 secondary structure / penalty mask (-nosecstr2)",
1112
"helixgap" => "Helix gap penalty (-helixgap)",
1113
"strandgap" => "Strand gap penalty (-strandgap)",
1114
"loopgap" => "Loop gap penalty (-loopgap)",
1115
"terminalgap" => "Secondary structure terminal penalty (-terminalgap)",
1116
"helixendin" => "Helix terminal positions: number of residues inside helix to be treated as terminal (-helixendin)",
1117
"helixendout" => "Helix terminal positions: number of residues outside helix to be treated as terminal (-helixendout)",
1118
"strandendin" => "Strand terminal positions: number of residues inside strand to be treated as terminal (-strandendin)",
1119
"strandendout" => "Strand terminal positions: number of residues outside strand to be treated as terminal (-strandendout)",
1120
"secstrout" => "Output in alignment (-secstrout)",
1124
$self->{ISSTANDOUT} = {
1140
"hgapresidues" => 0,
1171
"readseq_ok_aligfile" => 0,
1173
"phylipnewtreefile" => 0,
1191
"strandendout" => 0,
1198
"actions" => ['-align','-align: do full multiple alignment','-profile','-profile: merge two alignments (PROFILE1 and 2) by profile or structure alignment','-sequences','-sequences: sequentially add PROFILE2 sequences to PROFILE1 alignment','-tree','-tree: calculate NJ tree','-bootstrap','-bootstrap: bootstrap a NJ tree',],
1199
"multalign" => ['quicktree','typeseq','matrix','dnamatrix','gapopen','gapext','endgaps','gapdist','pgap','hgap','hgapresidues','maxdiv','negative','transweight','newtree','usetree',],
1200
"quicktree" => ['slow','Slow','fast','Fast',],
1201
"typeseq" => ['protein','protein','dna','DNA',],
1202
"matrix" => ['gonnet','Gonnet series','blosum','BLOSUM series','pam','PAM series','id','Identity matrix',],
1203
"dnamatrix" => ['iub','IUB','clustalw','CLUSTALW',],
1204
"hgapresidues" => ['A','A','R','R','N','N','D','D','C','C','Q','Q','E','E','G','G','H','H','I','I','L','L','K','K','M','M','F','F','P','P','S','S','T','T','W','W','Y','Y','V','V',],
1205
"fastpw" => ['ktuple','topdiags','window','pairgap','score',],
1206
"score" => ['percent','percent','absolute','absolute',],
1207
"slowpw" => ['pwmatrix','pwdnamatrix','pwgapopen','pwgapext',],
1208
"pwmatrix" => ['blosum','BLOSUM30 (Henikoff)','gonnet','Gonnet 250','pam','PAM350 (Dayhoff)','id','Identity matrix',],
1209
"pwdnamatrix" => ['iub','IUB','clustalw','CLUSTALW',],
1210
"trees" => ['kimura','tossgaps','bootstrap','bootlabels','seed','outputtree',],
1211
"bootlabels" => ['node','NODE labels','branch','BRANCH labels',],
1212
"outputtree" => ['NJ','Clustal format','PHYLIP','Phylip format tree','DIST','Phylip format distance matrix','NEXUS','NEXUS format tree',],
1213
"outputparam" => ['outfile','output','gde_lower','outorder','seqnos',],
1214
"output" => ['','CLUSTALW','GCG','GCG','GDE','GDE','PHYLIP','PHYLIP','PIR','PIR','NEXUS','NEXUS',],
1215
"outorder" => ['input','input','aligned','aligned',],
1216
"profile" => ['profile1','profile2','usetree1','usetree2','newtree1','newtree2',],
1217
"structure" => ['nosecstr1','nosecstr2','helixgap','strandgap','loopgap','terminalgap','helixendin','helixendout','strandendin','strandendout','secstrout',],
1218
"secstrout" => ['STRUCTURE','Secondary Structure','MASK','Gap Penalty Mask','BOTH','Structure and Penalty Mask','NONE','None',],
1225
$self->{SEPARATOR} = {
1226
"hgapresidues" => "''",
1231
"actions" => '-align',
1232
"phylip_alig" => '0',
1233
"quicktree" => 'slow',
1234
"matrix" => 'gonnet',
1235
"dnamatrix" => 'iub',
1236
"gapopen" => '10.00',
1242
"hgapresidues" => ['G','P','S','N','D','Q','E','K','R',],
1245
"transweight" => '0.5',
1250
"pwmatrix" => 'gonnet',
1251
"pwdnamatrix" => 'iub',
1252
"pwgapopen" => '10.00',
1253
"pwgapext" => '0.10',
1256
"bootstrap" => '1000',
1257
"bootlabels" => 'node',
1258
"outputtree" => 'PHYLIP',
1260
"outorder" => 'aligned',
1267
"terminalgap" => '2',
1268
"helixendin" => '3',
1269
"helixendout" => '0',
1270
"strandendin" => '1',
1271
"strandendout" => '1',
1272
"secstrout" => 'STRUCTURE',
1276
$self->{PRECOND} = {
1277
"clustalw" => { "perl" => '1' },
1279
"perl" => '$actions ne "-profile" && $actions ne "-sequences"',
1281
"actions" => { "perl" => '1' },
1282
"phylip_alig" => { "perl" => '1' },
1284
"perl" => '($actions =~ /align/ )',
1287
"perl" => '($actions =~ /align/ )',
1290
"perl" => '($actions =~ /align/ )',
1293
"perl" => '($actions =~ /align/ )',
1296
"perl" => '($actions =~ /align/ )',
1299
"perl" => '($actions =~ /align/ )',
1302
"perl" => '($actions =~ /align/ )',
1305
"perl" => '($actions =~ /align/ )',
1308
"perl" => '($actions =~ /align/ )',
1311
"perl" => '($actions =~ /align/ )',
1314
"perl" => '($actions =~ /align/ )',
1317
"perl" => '($actions =~ /align/ ) && $hgap',
1320
"perl" => '($actions =~ /align/ )',
1323
"perl" => '($actions =~ /align/ )',
1326
"perl" => '($actions =~ /align/ )',
1329
"perl" => '($actions =~ /align/ )',
1332
"perl" => '($actions =~ /align/ )',
1335
"perl" => '($quicktree eq "fast")',
1338
"perl" => '($quicktree eq "fast") && ($quicktree eq "fast")',
1341
"perl" => '($quicktree eq "fast") && ($quicktree eq "fast")',
1344
"perl" => '($quicktree eq "fast") && ($quicktree eq "fast")',
1347
"perl" => '($quicktree eq "fast") && ($quicktree eq "fast")',
1350
"perl" => '($quicktree eq "fast") && ($quicktree eq "fast")',
1353
"perl" => '($quicktree eq "slow")',
1356
"perl" => '($quicktree eq "slow") && ($quicktree eq "slow")',
1359
"perl" => '($quicktree eq "slow") && ($quicktree eq "slow")',
1362
"perl" => '($quicktree eq "slow") && ($quicktree eq "slow")',
1365
"perl" => '($quicktree eq "slow") && ($quicktree eq "slow")',
1368
"perl" => ' ($actions =~ /tree/) ',
1371
"perl" => ' ($actions =~ /tree/) ',
1374
"perl" => ' ($actions =~ /tree/) ',
1377
"perl" => ' ($actions =~ /tree/) ',
1380
"perl" => ' ($actions =~ /tree/) ',
1383
"perl" => ' ($actions =~ /tree/) ',
1386
"perl" => ' ($actions =~ /tree/) ',
1388
"outputparam" => { "perl" => '1' },
1389
"outfile" => { "perl" => '1' },
1390
"output" => { "perl" => '1' },
1392
"perl" => '$output eq "GDE"',
1394
"outorder" => { "perl" => '1' },
1396
"perl" => '$output eq ""',
1398
"aligfile" => { "perl" => '1' },
1399
"readseq_ok_aligfile" => {
1400
"perl" => '$output eq "GCG" || $output eq "PIR" || $output eq "PHYLIP" || $phylip_alig',
1402
"newtreefile" => { "perl" => '1' },
1403
"phylipnewtreefile" => { "perl" => '1' },
1405
"perl" => '($actions =~ /profile|sequence/ )',
1408
"perl" => '($actions =~ /profile|sequence/ )',
1411
"perl" => '($actions =~ /profile|sequence/ )',
1414
"perl" => '($actions =~ /profile|sequence/ )',
1417
"perl" => '($actions =~ /profile|sequence/ ) && (! $actions =~ /sequence/ )',
1420
"perl" => '($actions =~ /profile|sequence/ )',
1423
"perl" => '($actions =~ /profile|sequence/ ) && (! $actions =~ /sequence/ )',
1426
"perl" => '($actions =~ /profile|sequence/ )',
1429
"perl" => '($actions =~ /profile|sequence/ )',
1432
"perl" => '($actions =~ /profile|sequence/ )',
1435
"perl" => '($actions =~ /profile|sequence/ )',
1438
"perl" => '($actions =~ /profile|sequence/ )',
1441
"perl" => '($actions =~ /profile|sequence/ )',
1444
"perl" => '($actions =~ /profile|sequence/ )',
1447
"perl" => '($actions =~ /profile|sequence/ )',
1450
"perl" => '($actions =~ /profile|sequence/ )',
1453
"perl" => '($actions =~ /profile|sequence/ )',
1456
"perl" => '($actions =~ /profile|sequence/ )',
1459
"perl" => '($actions =~ /profile|sequence/ )',
1468
$self->{PIPEOUT} = {
1470
'1' => "readseq_ok_alig",
1473
'1' => "readseq_ok_alig",
1475
"readseq_ok_aligfile" => {
1476
'1' => "readseq_ok_alig",
1478
"phylipnewtreefile" => {
1479
'1' => "phylip_tree",
1484
$self->{WITHPIPEOUT} = {
1491
"readseq_ok_alig" => '1',
1496
$self->{WITHPIPEIN} = {
1500
$self->{ISCLEAN} = {
1516
"hgapresidues" => 0,
1547
"readseq_ok_aligfile" => 0,
1549
"phylipnewtreefile" => 0,
1567
"strandendout" => 0,
1572
$self->{ISSIMPLE} = {
1588
"hgapresidues" => 0,
1619
"readseq_ok_aligfile" => 0,
1621
"phylipnewtreefile" => 0,
1639
"strandendout" => 0,
1644
$self->{PARAMFILE} = {
1648
$self->{COMMENT} = {
1650
"Multiple alignments are carried out in 3 stages :",
1651
"1) all sequences are compared to each other (pairwise alignments);",
1652
"2) a dendrogram (like a phylogenetic tree) is constructed, describing the approximate groupings of the sequences by similarity (stored in a file).",
1653
"3) the final multiple alignment is carried out, using the dendrogram as a guide.",
1654
"Pairwise alignment parameters control the speed/sensitivity of the initial alignments.",
1655
"Multiple alignment parameters control the gaps in the final multiple alignments.",
1658
"slow: by dynamic programming (slow but accurate)",
1659
"fast: method of Wilbur and Lipman (extremely fast but approximate)",
1662
"There are three \'in-built\' series of weight matrices offered. Each consists of several matrices which work differently at different evolutionary distances. To see the exact details, read the documentation. Crudely, we store several matrices in memory, spanning the full range of amino acid distance (from almost identical sequences to highly divergent ones). For very similar sequences, it is best to use a strict weight matrix which only gives a high score to identities and the most favoured conservative substitutions. For more divergent sequences, it is appropriate to use \'softer\' matrices which give a high score to many other frequent substitutions.",
1663
"BLOSUM (Henikoff). These matrices appear to be the best available for carrying out data base similarity (homology searches). The matrices used are: Blosum80, 62, 40 and 30.",
1664
"The Gonnet Pam 250 matrix has been reported as the best single matrix for alignment, if you only choose one matrix. Our experience with profile database searches is that the Gonnet series is unambiguously superior to the Blosum series at high divergence. However, we did not get the series to perform systematically better than the Blosum series in Clustal W (communication of the authors).",
1665
"PAM (Dayhoff). These have been extremely widely used since the late \'70s. We use the PAM 120, 160, 250 and 350 matrices.",
1668
"1) IUB. This is the default scoring matrix used by BESTFIT for the comparison of nucleic acid sequences. X\'s and N\'s are treated as matches to any IUB ambiguity symbol. All matches score 1.9; all mismatches for IUB symbols score 0.",
1669
"2) CLUSTALW(1.6). The previous system used by ClustalW, in which matches score 1.0 and mismatches score 0. All matches for IUB symbols also score 0.",
1675
"End gap separation treats end gaps just like internal gaps for the purposes of avoiding gaps that are too close (set by GAP SEPARATION DISTANCE above). If you turn this off, end gaps will be ignored for this purpose. This is useful when you wish to align fragments where the end gaps are not biologically meaningful.",
1678
"Gap separation distance tries to decrease the chances of gaps being too close to each other. Gaps that are less than this distance apart are penalised more than other gaps. This does not prevent close gaps; it makes them less frequent, promoting a block-like appearance of the alignment.",
1681
"Residue specific penalties are amino acid specific gap penalties that reduce or increase the gap opening penalties at each position in the alignment or sequence. As an example, positions that are rich in glycine are more likely to have an adjacent gap than positions that are rich in valine.",
1682
"Table of residue specific gap modification factors:",
1693
"The values are normalised around a mean value of 1.0 for H. The lower the value, the greater the chance of having an adjacent gap. These are derived from the original table of relative frequencies of gaps adjacent to each residue (12) by subtraction from 2.0.",
1696
"Hydrophilic gap penalties are used to increase the chances of a gap within a run (5 or more residues) of hydrophilic amino acids; these are likely to be loop or random coil regions where gaps are more common. The residues that are \'considered\' to be hydrophilic are set by menu item 3.",
1699
"Delays the alignment of the most distantly related sequences until after the most closely related sequences have been aligned. The setting shows the percent identity level required to delay the addition of a sequence; sequences that are less identical than this level to any other sequences will be aligned later.",
1702
"The transition weight option for aligning nucleotide sequences has been changed in version 1.7 from an on/off toggle to a weight between 0 and 1. A weight of zero means that the transitions are scored as mismatches; a weight of 1 gives transitions the full match score. For distantly related DNA sequences, the weight should be near to zero; for closely related sequences it can be useful to assign a higher score.",
1705
"You can give a previously computed tree (.dnd file) - on the same data",
1708
"These similarity scores are calculated from fast, approximate, global alignments, which are controlled by 4 parameters. 2 techniques are used to make these alignments very fast: 1) only exactly matching fragments (k-tuples) are considered; 2) only the \'best\' diagonals (the ones with most k-tuple matches) are used.",
1711
"K-TUPLE SIZE: This is the size of exactly matching fragment that is used. INCREASE for speed (max= 2 for proteins; 4 for DNA), DECREASE for sensitivity. For longer sequences (e.g. >1000 residues) you may need to increase the default.",
1714
"The number of k-tuple matches on each diagonal (in an imaginary dot-matrix plot) is calculated. Only the best ones (with most matches) are used in the alignment. This parameter specifies how many. Decrease for speed; increase for sensitivity.",
1717
"WINDOW SIZE: This is the number of diagonals around each of the \'best\' diagonals that will be used. Decrease for speed; increase for sensitivity",
1720
"This is a penalty for each gap in the fast alignments. It has little affect on the speed or sensitivity except for extreme values.",
1723
"These parameters do not have any affect on the speed of the alignments. They are used to give initial alignments which are then rescored to give percent identity scores. These % scores are the ones which are displayed on the screen. The scores are converted to distances for the trees.",
1726
"The scoring table which describes the similarity of each amino acid to each other. For DNA, an identity matrix is used.",
1727
"BLOSUM (Henikoff). These matrices appear to be the best available for carrying out data base similarity (homology searches). The matrices used are: Blosum80, 62, 40 and 30.",
1728
"The Gonnet Pam 250 matrix has been reported as the best single matrix for alignment, if you only choose one matrix. Our experience with profile database searches is that the Gonnet series is unambiguously superior to the Blosum series at high divergence. However, we did not get the series to perform systematically better than the Blosum series in Clustal W (communication of the authors).",
1729
"PAM (Dayhoff). These have been extremely widely used since the late \'70s. We use the PAM 120, 160, 250 and 350 matrices.",
1732
"For DNA, a single matrix (not a series) is used. Two hard-coded matrices are available:",
1733
"1) IUB. This is the default scoring matrix used by BESTFIT for the comparison of nucleic acid sequences. X\'s and N\'s are treated as matches to any IUB ambiguity symbol. All matches score 1.9; all mismatches for IUB symbols score 0.",
1734
"2) CLUSTALW(1.6). The previous system used by ClustalW, in which matches score 1.0 and mismatches score 0. All matches for IUB symbols also score 0.",
1737
"If you ask for an alignment, the program automatic computes the tree as well; but you can also ask for a tree, given an alignment (file .aln), with specific options.",
1738
"The method used is the NJ (Neighbour Joining) method of Saitou and Nei. First you calculate distances (percent divergence) between all pairs of sequence from a multiple alignment; second you apply the NJ method to the distance matrix.",
1741
"For small divergence (say <10%) this option makes no difference. For greater divergence, this option corrects for the fact that observed distances underestimate actual evolutionary distances. This is because, as sequences diverge, more than one substitution will happen at many sites. However, you only see one difference when you look at the present day sequences. Therefore, this option has the effect of stretching (for DNA or proteins) are both due to Motoo Kimura. See the documentation for details. ",
1742
"For VERY divergent sequences, the distances cannot be reliably corrected. You will be warned if this happens. Even if none of the distances in a data set exceed the reliable threshold, if you bootstrap the data, some of the bootstrap distances may randomly exceed the safe limit.",
1745
"With this option, any alignment positions where ANY of the sequences have a gap will be ignored. This means that \'like\' will be compared to \'like\' in all distances. It also, automatically throws away the most ambiguous parts of the alignment, which are concentrated around gaps (usually). The disadvantage is that you may throw away much of the data if there are many gaps. ",
1748
"BOOTSTRAPPING is a method for deriving confidence values for the groupings in a tree (first adapted for trees by Joe Felsenstein). It involves making N random samples of sites from the alignment (N should be LARGE, e.g. 500 - 1000); drawing N trees (1 from each sample) and counting how many times each grouping from the original tree occurs in the sample trees. You must supply a seed number for the random number generator. Different runs with the same seed will give the same answer. See the documentation for details.",
1751
"The bootstrap values written in the phylip tree file format can be assigned either to branches or nodes. The default is to write the values on the nodes, as this can be read by several commonly-used tree display programs. But note that this can lead to confusion if the tree is rooted and the bootstraps may be better attached to the internal branches: Software developers should ensure they can read the branch label format.",
1754
"Clustal format output: This format is verbose and lists all of the distances between the sequences and the number of alignment positions used for each. The tree is described at the end of the file. It lists the sequences that are joined at each alignment step and the branch lengths. After two sequences are joined, it is referred to later as a NODE. The number of a NODE is the number of the lowest sequence in that NODE. ",
1755
"Phylip format tree output: This format is the New Hampshire format, used by many phylogenetic analysis packages. It consists of a series of nested parentheses, describing the branching order, with the sequence names and branch lengths. It can be used by the RETREE, DRAWGRAM and DRAWTREE programs of the PHYLIP package to see the trees graphically. This is the same format used during multiple alignment for the guide trees. ",
1756
"The distance matrix only: This format just outputs a matrix of all the pairwise distances in a format that can be used by the Phylip package. It used to be useful when one could not produce distances from protein sequences in the Phylip package but is now redundant (Protdist of Phylip 3.5 now does this). ",
1757
"NEXUS format tree: This format is used by several popular phylogeny programs, including PAUP and MacClade. ",
1760
"By PROFILE ALIGNMENT, we mean alignment using existing alignments. Profile alignments allow you to store alignments of your favourite sequences and add new sequences to them in small bunches at a time. A profile is simply an alignment of one or more sequences (e.g. an alignment output file from CLUSTAL W). Each input can be a single sequence. One or both sets of input sequences may include secondary structure assignments or gap penalty masks to guide the alignment.",
1761
"Give 2 profiles to align the 2 profiles to each other",
1764
"These options, when doing a profile alignment, allow you to set 2D structure parameters. If a solved structure is available, it can be used to guide the alignment by raising gap penalties within secondary structure elements, so that gaps will preferentially be inserted into unstructured surface loops. Alternatively, a user-specified gap penalty mask can be supplied directly.",
1765
"A gap penalty mask is a series of numbers between 1 and 9, one per position in the alignment. Each number specifies how much the gap opening penalty is to be raised at that position (raised by multiplying the basic gap opening penalty by the number) i.e. a mask figure of 1 at a position means no change in gap opening penalty; a figure of 4 means that the gap opening penalty is four times greater at that position, making gaps 4 times harder to open.",
1766
"Gap penalty masks is to be supplied with the input sequences. The masks work by raising gap penalties in specified regions (typically secondary structure elements) so that gaps are preferentially opened in the less well conserved regions (typically surface loops).",
1767
"CLUSTAL W can read the masks from SWISS-PROT, CLUSTAL or GDE format input files. For many 3-D protein structures, secondary structure information is recorded in the feature tables of SWISS-PROT database entries. You should always check that the assignments are correct - some are quite inaccurate. CLUSTAL W looks for SWISS-PROT HELIX and STRAND assignments e.g.",
1770
"The structure and penalty masks can also be read from CLUSTAL alignment format as comment lines beginning !SS_ or GM_ e.g.",
1771
"!SS_HBA_HUMA ..aaaAAAAAAAAAAaaa.aaaAAAAAAAAAAaaaaaaAaaa.........aaaAAAAAA",
1772
"!GM_HBA_HUMA 112224444444444222122244444444442222224222111111111222444444",
1773
"HBA_HUMA VLSPADKTNVKAAWGKVGAHAGEYGAEALERMFLSFPTTKTYFPHFDLSHGSAQVKGHGK",
1774
"Note that the mask itself is a set of numbers between 1 and 9 each of which is assigned to the residue(s) in the same column below. In GDE flat file format, the masks are specified as text and the names must begin with SS_ or GM_. Either a structure or penalty mask or both may be used. If both are included in an alignment, the user will be asked which is to be used.",
1777
"This option controls whether the input secondary structure information or gap penalty masks will be used.",
1780
"This option controls whether the input secondary structure information or gap penalty masks will be used.",
1783
"This option provides the value for raising the gap penalty at core Alpha Helical (A) residues. In CLUSTAL format, capital residues denote the A and B core structure notation. The basic gap penalties are multiplied by the amount specified.",
1786
"This option provides the value for raising the gap penalty at Beta Strand (B) residues. In CLUSTAL format, capital residues denote the A and B core structure notation. The basic gap penalties are multiplied by the amount specified.",
1789
"This option provides the value for the gap penalty in Loops. By default this penalty is not raised. In CLUSTAL format, loops are specified by . in the secondary structure notation.",
1792
"This option provides the value for setting the gap penalty at the ends of secondary structures. Ends of secondary structures are observed to grow and-or shrink in related structures. Therefore by default these are given intermediate values, lower than the core penalties. All secondary structure read in as lower case in CLUSTAL format gets the reduced terminal penalty.",
1795
"This option (together with the -helixendin) specify the range of structure termini for the intermediate penalties. In the alignment output, these are indicated as lower case. For Alpha Helices, by default, the range spans the end helical turn.",
1798
"This option (together with the -helixendin) specify the range of structure termini for the intermediate penalties. In the alignment output, these are indicated as lower case. For Alpha Helices, by default, the range spans the end helical turn.",
1801
"This option (together with the -strandendout option) specify the range of structure termini for the intermediate penalties. In the alignment output, these are indicated as lower case. For Beta Strands, the default range spans the end residue and the adjacent loop residue, since sequence conservation often extends beyond the actual H-bonded Beta Strand.",
1804
"This option (together with the -strandendin option) specify the range of structure termini for the intermediate penalties. In the alignment output, these are indicated as lower case. For Beta Strands, the default range spans the end residue and the adjacent loop residue, since sequence conservation often extends beyond the actual H-bonded Beta Strand.",
1807
"This option lets you choose whether or not to include the masks in the CLUSTAL W output alignments. Showing both is useful for understanding how the masks work. The secondary structure information is itself very useful in judging the alignment quality and in seeing how residue conservation patterns vary with secondary structure.",
1812
$self->{SCALEMIN} = {
1816
$self->{SCALEMAX} = {
1820
$self->{SCALEINC} = {
1828
# -- end of definitions extracted from /local/gensoft/lib/Pise/5.a/PerlDef/clustalw.pm
1832
$self->_init_params(@params);
1839
1; # Needed to keep compiler happy
added
removed
Bio/Tools/Run/PiseApplication/clustalw.pm
