-
Notifications
You must be signed in to change notification settings - Fork 23
/
Copy pathpsiblast.pl
1377 lines (1132 loc) · 44.8 KB
/
psiblast.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env perl
=head1 NAME
psiblast.pl
=head1 DESCRIPTION
PSI-Blast (REST) web service Perl client using L<LWP>.
Tested with:
=over
=item *
L<LWP> 6.35, L<XML::Simple> 2.25 and Perl 5.22.0 (MacOS 10.13.6)
=back
For further information see:
=over
=item *
L<https://www.ebi.ac.uk/Tools/webservices/>
=back
=head1 LICENSE
Copyright 2012-2024 EMBL - European Bioinformatics Institute
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Perl Client Automatically generated with:
https://github.com/ebi-jdispatcher/webservice-clients-generator
=cut
# ======================================================================
# Enable Perl warnings
use strict;
use warnings;
# Load libraries
use English;
use LWP;
use XML::Simple;
use Getopt::Long qw(:config no_ignore_case bundling);
use File::Basename;
use Data::Dumper;
use Time::HiRes qw(usleep);
# Base URL for service
my $baseUrl = 'https://www.ebi.ac.uk/Tools/services/rest/psiblast';
my $version = '2024-07-12 11:05';
# Set interval for checking status
my $checkInterval = 3;
# Set maximum number of 'ERROR' status calls to call job failed.
my $maxErrorStatusCount = 3;
# Output level
my $outputLevel = 1;
# Process command-line options
my $numOpts = scalar(@ARGV);
my %params = (
'debugLevel' => 0,
'maxJobs' => 1
);
my @database;
# Default parameter values (should get these from the service)
GetOptions(
# Tool specific options
'matrix=s' => \$params{'matrix'}, # The comparison matrix to be used to score alignments when searching the database
'gapopen=i' => \$params{'gapopen'}, # Penalty taken away from the score when a gap is created in sequence. Increasing the gap openning penalty will decrease the number of gaps in the final alignment.
'gapext=i' => \$params{'gapext'}, # Penalty taken away from the score for each base or residue in the gap. Increasing the gap extension penalty favors short gaps in the final alignment, conversly decreasing the gap extension penalty favors long gaps in the final alignment.
'expthr=f' => \$params{'expthr'}, # Limits the number of scores and alignments reported based on the expectation value. This is the maximum number of times the match is expected to occur by chance.
'psithr=f' => \$params{'psithr'}, # Expectation value threshold for automatic selection of matched sequences for inclusion in PSSM at each iteration.
'scores=i' => \$params{'scores'}, # Maximum number of match score summaries reported in the result output.
'alignments=i' => \$params{'alignments'}, # Maximum number of match alignments reported in the result output.
'alignView=i' => \$params{'alignView'}, # Formating for the alignments
'dropoff=i' => \$params{'dropoff'}, # The amount a score can drop before extension of word hits is halted
'finaldropoff=i' => \$params{'finaldropoff'}, # Dropoff value for final gapped alignment
'filter=s' => \$params{'filter'}, # Filter regions of low sequence complexity. This can avoid issues with low complexity sequences where matches are found due to composition rather than meaningful sequence similarity. However in some cases filtering also masks regions of interest and so should be used with caution.
'seqrange=s' => \$params{'seqrange'}, # Specify a range or section of the input sequence to use in the search. Example: Specifying '34-89' in an input sequence of total length 100, will tell BLAST to only use residues 34 to 89, inclusive.
'sequence=s' => \$params{'sequence'}, # The query sequence can be entered directly into this form. The sequence can be in GCG, FASTA, PIR, NBRF, PHYLIP or UniProtKB/Swiss-Prot format. A partially formatted sequence is not accepted. Adding a return to the end of the sequence may help certain applications understand the input. Note that directly using data from word processors may yield unpredictable results as hidden/control characters may be present.
'database=s' => \@database, # The databases to run the sequence similarity search against. Multiple databases can be used at the same time
'previousjobid=s' => \$params{'previousjobid'}, # The job identifier for the previous PSI-BLAST iteration.
'selectedHits=f' => \$params{'selectedHits'}, # List of identifiers of the hits from the previous iteration to use to construct the search PSSM for this iteration.
'cpfile=f' => \$params{'cpfile'}, # Checkpoint file from the previous iteration. Must be in ASN.1 Binary Format.
'patfile=f' => \$params{'patfile'}, # Pattern file for PHI-BLAST functionality. This file needs to be in the style of a prosite entry file, with at least an ID line, PA line and optional HI line.
# Generic options
'email=s' => \$params{'email'}, # User e-mail address
'title=s' => \$params{'title'}, # Job title
'outfile=s' => \$params{'outfile'}, # Output file name
'outformat=s' => \$params{'outformat'}, # Output file type
'jobid=s' => \$params{'jobid'}, # JobId
'help|h' => \$params{'help'}, # Usage help
'asyncjob' => \$params{'asyncjob'}, # Asynchronous submission
'polljob' => \$params{'polljob'}, # Get results
'pollFreq=f' => \$params{'pollFreq'}, # Poll Frequency
'resultTypes' => \$params{'resultTypes'}, # Get result types
'status' => \$params{'status'}, # Get status
'params' => \$params{'params'}, # List input parameters
'paramDetail=s' => \$params{'paramDetail'}, # Get details for parameter
'multifasta' => \$params{'multifasta'}, # Multiple fasta input
'useSeqId' => \$params{'useSeqId'}, # Seq Id file name
'maxJobs=i' => \$params{'maxJobs'}, # Max. parallel jobs
'verbose' => \$params{'verbose'}, # Increase output level
'version' => \$params{'version'}, # Prints out the version of the Client and exit.
'quiet' => \$params{'quiet'}, # Decrease output level
'debugLevel=i' => \$params{'debugLevel'}, # Debugging level
'baseUrl=s' => \$baseUrl, # Base URL for service.
);
if ($params{'verbose'}) {$outputLevel++}
if ($params{'quiet'}) {$outputLevel--}
if ($params{'pollFreq'}) {$checkInterval = $params{'pollFreq'} * 1000 * 1000}
if ($params{'baseUrl'}) {$baseUrl = $params{'baseUrl'}}
$params{"database"} = [@database];
# Debug mode: LWP version
&print_debug_message('MAIN', 'LWP::VERSION: ' . $LWP::VERSION,
1);
# Debug mode: print the input parameters
&print_debug_message('MAIN', "params:\n" . Dumper(\%params), 11);
# LWP UserAgent for making HTTP calls (initialised when required).
my $ua;
# Get the script filename for use in usage messages
my $scriptName = basename($0, ());
# Print usage and exit if requested
if ($params{'help'} || $numOpts == 0) {
&usage();
exit(0);
}
# Debug mode: show the base URL
&print_debug_message('MAIN', 'baseUrl: ' . $baseUrl, 1);
if (
!(
$params{'polljob'}
|| $params{'resultTypes'}
|| $params{'status'}
|| $params{'params'}
|| $params{'paramDetail'}
|| $params{'version'}
)
&& !(defined($ARGV[0]) || defined($params{'sequence'}))
) {
# Bad argument combination, so print error message and usage
print STDERR 'Error: bad option combination', "\n";
&usage();
exit(1);
}
# Get parameters list
elsif ($params{'params'}) {
&print_tool_params();
}
# Get parameter details
elsif ($params{'paramDetail'}) {
&print_param_details($params{'paramDetail'});
}
# Print Client version
elsif ($params{'version'}) {
print STDOUT 'Revision: ' . $version, "\n";
exit(1);
}
# Job status
elsif ($params{'status'} && defined($params{'jobid'})) {
&print_job_status($params{'jobid'});
}
# Result types
elsif ($params{'resultTypes'} && defined($params{'jobid'})) {
&print_result_types($params{'jobid'});
}
# Poll job and get results
elsif ($params{'polljob'} && defined($params{'jobid'})) {
&get_results($params{'jobid'});
}
# Submit a job
else {
# Multiple input sequence mode, assume fasta format.
if (defined($params{'multifasta'}) && $params{'multifasta'}) {
&multi_submit_job();
}
# Entry identifier list file.
elsif ((defined($params{'sequence'}) && $params{'sequence'} =~ m/^\@/)
|| (defined($ARGV[0]) && $ARGV[0] =~ m/^\@/)) {
my $list_filename = $params{'sequence'} || $ARGV[0];
$list_filename =~ s/^\@//;
&list_file_submit_job($list_filename);
}
# Default: single sequence/identifier.
else {
# Warn for invalid batch only option use.
if (defined($params{'useSeqId'}) && $params{'useSeqId'}) {
print STDERR "Warning: --useSeqId option ignored.\n";
delete $params{'useSeqId'};
}
if (defined($params{'maxJobs'}) && $params{'maxJobs'} > 1) {
print STDERR "Warning: --maxJobs option ignored.\n";
$params{'maxJobs'} = 1;
}
# Load the sequence data and submit.
&submit_job(&load_data());
}
}
=head1 FUNCTIONS
=cut
### Wrappers for REST resources ###
=head2 rest_user_agent()
Get a LWP UserAgent to use to perform REST requests.
my $ua = &rest_user_agent();
=cut
sub rest_user_agent() {
print_debug_message('rest_user_agent', 'Begin', 21);
# Create an LWP UserAgent for making HTTP calls.
my $ua = LWP::UserAgent->new();
# Set 'User-Agent' HTTP header to identifiy the client.
my $revisionNumber = 0;
$revisionNumber = "Revision: " . $version;
$ua->agent("EBI-Sample-Client/$revisionNumber ($scriptName; $OSNAME) " . $ua->agent());
# Configure HTTP proxy support from environment.
$ua->env_proxy;
print_debug_message('rest_user_agent', 'End', 21);
return $ua;
}
=head2 rest_error()
Check a REST response for an error condition. An error is mapped to a die.
&rest_error($response, $content_data);
=cut
sub rest_error() {
print_debug_message('rest_error', 'Begin', 21);
my $response = shift;
my $contentdata;
if (scalar(@_) > 0) {
$contentdata = shift;
}
if (!defined($contentdata) || $contentdata eq '') {
$contentdata = $response->content();
}
# Check for HTTP error codes
if ($response->is_error) {
my $error_message = '';
# HTML response.
if ($contentdata =~ m/<h1>([^<]+)<\/h1>/) {
$error_message = $1;
}
# XML response.
elsif ($contentdata =~ m/<description>([^<]+)<\/description>/) {
$error_message = $1;
}
# die 'http status: ' . $response->code . ' ' . $response->message . ' ' . $error_message;
}
print_debug_message('rest_error', 'End', 21);
}
=head2 rest_request()
Perform a REST request (HTTP GET).
my $response_str = &rest_request($url);
=cut
sub rest_request {
print_debug_message('rest_request', 'Begin', 11);
my $requestUrl = shift;
print_debug_message('rest_request', 'URL: ' . $requestUrl, 11);
# Get an LWP UserAgent.
$ua = &rest_user_agent() unless defined($ua);
# Available HTTP compression methods.
my $can_accept;
eval {
$can_accept = HTTP::Message::decodable();
};
$can_accept = '' unless defined($can_accept);
# Perform the request
my $response = $ua->get($requestUrl,
'Accept-Encoding' => $can_accept, # HTTP compression.
);
print_debug_message('rest_request', 'HTTP status: ' . $response->code,
11);
print_debug_message('rest_request',
'response length: ' . length($response->content()), 11);
print_debug_message('rest_request',
'request:' . "\n" . $response->request()->as_string(), 32);
print_debug_message('rest_request',
'response: ' . "\n" . $response->as_string(), 32);
# Unpack possibly compressed response.
my $retVal;
if (defined($can_accept) && $can_accept ne '') {
$retVal = $response->decoded_content();
}
# If unable to decode use orginal content.
$retVal = $response->content() unless defined($retVal);
# Check for an error.
&rest_error($response, $retVal);
print_debug_message('rest_request', 'retVal: ' . $retVal, 12);
print_debug_message('rest_request', 'End', 11);
# Return the response data
return $retVal;
}
=head2 rest_get_parameters()
Get list of tool parameter names.
my (@param_list) = &rest_get_parameters();
=cut
sub rest_get_parameters {
print_debug_message('rest_get_parameters', 'Begin', 1);
my $url = $baseUrl . '/parameters/';
my $param_list_xml_str = rest_request($url);
my $param_list_xml = XMLin($param_list_xml_str);
my (@param_list) = @{$param_list_xml->{'id'}};
print_debug_message('rest_get_parameters', 'End', 1);
return(@param_list);
}
=head2 rest_get_parameter_details()
Get details of a tool parameter.
my $paramDetail = &rest_get_parameter_details($param_name);
=cut
sub rest_get_parameter_details {
print_debug_message('rest_get_parameter_details', 'Begin', 1);
my $parameterId = shift;
print_debug_message('rest_get_parameter_details',
'parameterId: ' . $parameterId, 1);
my $url = $baseUrl . '/parameterdetails/' . $parameterId;
my $param_detail_xml_str = rest_request($url);
my $param_detail_xml = XMLin($param_detail_xml_str);
print_debug_message('rest_get_parameter_details', 'End', 1);
return($param_detail_xml);
}
=head2 rest_run()
Submit a job.
my $job_id = &rest_run($email, $title, \%params );
=cut
sub rest_run {
print_debug_message('rest_run', 'Begin', 1);
my $email = shift;
my $title = shift;
my $params = shift;
$email = '' if (!$email);
print_debug_message('rest_run', 'email: ' . $email, 1);
if (defined($title)) {
print_debug_message('rest_run', 'title: ' . $title, 1);
}
print_debug_message('rest_run', 'params: ' . Dumper($params), 1);
# Get an LWP UserAgent.
$ua = &rest_user_agent() unless defined($ua);
# Clean up parameters
my (%tmp_params) = %{$params};
$tmp_params{'email'} = $email;
$tmp_params{'title'} = $title;
foreach my $param_name (keys(%tmp_params)) {
if (!defined($tmp_params{$param_name})) {
delete $tmp_params{$param_name};
}
}
# Submit the job as a POST
my $url = $baseUrl . '/run';
my $response = $ua->post($url, \%tmp_params);
print_debug_message('rest_run', 'HTTP status: ' . $response->code, 11);
print_debug_message('rest_run',
'request:' . "\n" . $response->request()->as_string(), 11);
print_debug_message('rest_run',
'response: ' . length($response->as_string()) . "\n" . $response->as_string(), 11);
# Check for an error.
&rest_error($response);
# The job id is returned
my $job_id = $response->content();
print_debug_message('rest_run', 'End', 1);
return $job_id;
}
=head2 rest_get_status()
Check the status of a job.
my $status = &rest_get_status($job_id);
=cut
sub rest_get_status {
print_debug_message('rest_get_status', 'Begin', 1);
my $job_id = shift;
print_debug_message('rest_get_status', 'jobid: ' . $job_id, 2);
my $status_str = 'UNKNOWN';
my $url = $baseUrl . '/status/' . $job_id;
$status_str = &rest_request($url);
print_debug_message('rest_get_status', 'status_str: ' . $status_str, 2);
print_debug_message('rest_get_status', 'End', 1);
return $status_str;
}
=head2 rest_get_result_types()
Get list of result types for finished job.
my (@result_types) = &rest_get_result_types($job_id);
=cut
sub rest_get_result_types {
print_debug_message('rest_get_result_types', 'Begin', 1);
my $job_id = shift;
print_debug_message('rest_get_result_types', 'jobid: ' . $job_id, 2);
my (@resultTypes);
my $url = $baseUrl . '/resulttypes/' . $job_id;
my $result_type_list_xml_str = &rest_request($url);
my $result_type_list_xml = XMLin($result_type_list_xml_str);
(@resultTypes) = @{$result_type_list_xml->{'type'}};
print_debug_message('rest_get_result_types',
scalar(@resultTypes) . ' result types', 2);
print_debug_message('rest_get_result_types', 'End', 1);
return(@resultTypes);
}
=head2 rest_get_result()
Get result data of a specified type for a finished job.
my $result = rest_get_result($job_id, $result_type);
=cut
sub rest_get_result {
print_debug_message('rest_get_result', 'Begin', 1);
my $job_id = shift;
my $type = shift;
print_debug_message('rest_get_result', 'jobid: ' . $job_id, 1);
print_debug_message('rest_get_result', 'type: ' . $type, 1);
my $url = $baseUrl . '/result/' . $job_id . '/' . $type;
my $result = &rest_request($url);
print_debug_message('rest_get_result', length($result) . ' characters',
1);
print_debug_message('rest_get_result', 'End', 1);
return $result;
}
### Service actions and utility functions ###
=head2 print_debug_message()
Print debug message at specified debug level.
&print_debug_message($method_name, $message, $level);
=cut
sub print_debug_message {
my $function_name = shift;
my $message = shift;
my $level = shift;
if ($level <= $params{'debugLevel'}) {
print STDERR '[', $function_name, '()] ', $message, "\n";
}
}
=head2 print_tool_params()
Print list of tool parameters.
&print_tool_params();
=cut
sub print_tool_params {
print_debug_message('print_tool_params', 'Begin', 1);
my (@param_list) = &rest_get_parameters();
foreach my $param (sort (@param_list)) {
print $param, "\n";
}
print_debug_message('print_tool_params', 'End', 1);
}
=head2 print_param_details()
Print details of a tool parameter.
&print_param_details($param_name);
=cut
sub print_param_details {
print_debug_message('print_param_details', 'Begin', 1);
my $paramName = shift;
print_debug_message('print_param_details', 'paramName: ' . $paramName, 2);
my $paramDetail = &rest_get_parameter_details($paramName);
print $paramDetail->{'name'}, "\t", $paramDetail->{'type'}, "\n";
print $paramDetail->{'description'}, "\n";
if (defined($paramDetail->{'values'}->{'value'})) {
if (ref($paramDetail->{'values'}->{'value'}) eq 'ARRAY') {
foreach my $value (@{$paramDetail->{'values'}->{'value'}}) {
&print_param_value($value);
}
}
else {
&print_param_value($paramDetail->{'values'}->{'value'});
}
}
print_debug_message('print_param_details', 'End', 1);
}
=head2 print_param_value()
Print details of a tool parameter value.
&print_param_details($param_value);
Used by print_param_details() to handle both singluar and array values.
=cut
sub print_param_value {
my $value = shift;
print $value->{'value'};
if ($value->{'defaultValue'} eq 'true') {
print "\t", 'default';
}
print "\n";
print "\t", $value->{'label'}, "\n";
if (defined($value->{'properties'})) {
foreach
my $key (sort ( keys(%{$value->{'properties'}{'property'}}) )) {
if (ref($value->{'properties'}{'property'}{$key}) eq 'HASH'
&& defined($value->{'properties'}{'property'}{$key}{'value'})
) {
print "\t", $key, "\t",
$value->{'properties'}{'property'}{$key}{'value'}, "\n";
}
else {
print "\t", $value->{'properties'}{'property'}{'key'},
"\t", $value->{'properties'}{'property'}{'value'}, "\n";
last;
}
}
}
}
=head2 print_job_status()
Print status of a job.
&print_job_status($job_id);
=cut
sub print_job_status {
print_debug_message('print_job_status', 'Begin', 1);
my $jobid = shift;
print_debug_message('print_job_status', 'jobid: ' . $jobid, 1);
if ($outputLevel > 0) {
print STDERR 'Getting status for job ', $jobid, "\n";
}
my $result = &rest_get_status($jobid);
print "$result\n";
if ($result eq 'FINISHED' && $outputLevel > 0) {
print STDERR "To get results: perl $scriptName --polljob --jobid " . $jobid
. "\n";
}
print_debug_message('print_job_status', 'End', 1);
}
=head2 print_result_types()
Print available result types for a job.
&print_result_types($job_id);
=cut
sub print_result_types {
print_debug_message('result_types', 'Begin', 1);
my $jobid = shift;
print_debug_message('result_types', 'jobid: ' . $jobid, 1);
if ($outputLevel > 0) {
print STDERR 'Getting result types for job ', $jobid, "\n";
}
my $status = &rest_get_status($jobid);
if ($status eq 'QUEUED' || $status eq 'RUNNING') {
print STDERR 'Error: Job status is ', $status,
'. To get result types the job must be finished.', "\n";
}
else {
my (@resultTypes) = &rest_get_result_types($jobid);
if ($outputLevel > 0) {
print STDOUT 'Available result types:', "\n";
}
foreach my $resultType (@resultTypes) {
print STDOUT $resultType->{'identifier'}, "\n";
if (defined($resultType->{'label'})) {
print STDOUT "\t", $resultType->{'label'}, "\n";
}
if (defined($resultType->{'description'})) {
print STDOUT "\t", $resultType->{'description'}, "\n";
}
if (defined($resultType->{'mediaType'})) {
print STDOUT "\t", $resultType->{'mediaType'}, "\n";
}
if (defined($resultType->{'fileSuffix'})) {
print STDOUT "\t", $resultType->{'fileSuffix'}, "\n";
}
}
if ($status eq 'FINISHED' && $outputLevel > 0) {
print STDERR "\n", 'To get results:', "\n",
" perl $scriptName --polljob --jobid " . $params{'jobid'} . "\n",
" perl $scriptName --polljob --outformat <type> --jobid "
. $params{'jobid'} . "\n";
}
}
print_debug_message('result_types', 'End', 1);
}
=head2 submit_job()
Submit a job to the service.
&submit_job($seq);
=cut
sub submit_job {
print_debug_message('submit_job', 'Begin', 1);
# Set input sequence
$params{'sequence'} = shift;
my $seq_id = shift;
# Load parameters
&load_params();
# Submit the job
my $jobid = &rest_run($params{'email'}, $params{'title'}, \%params);
# Asynchronous submission.
if (defined($params{'asyncjob'})) {
print STDOUT $jobid, "\n";
if ($outputLevel > 0) {
print STDERR
"To check status: perl $scriptName --status --jobid $jobid\n";
}
}
# Simulate synchronous submission serial mode.
else {
if ($outputLevel > 0) {
print STDERR "JobId: $jobid\n";
} else {
print STDERR "$jobid\n";
}
usleep($checkInterval);
# Get results.
&get_results($jobid, $seq_id);
}
print_debug_message('submit_job', 'End', 1);
return $jobid;
}
=head2 multi_submit_job()
Submit multiple jobs assuming input is a collection of fasta formatted sequences.
&multi_submit_job();
=cut
sub multi_submit_job {
print_debug_message('multi_submit_job', 'Begin', 1);
my (@filename_list) = ();
# Query sequence
if (defined($ARGV[0])) { # Bare option
if (-f $ARGV[0] || $ARGV[0] eq '-') { # File
push(@filename_list, $ARGV[0]);
}
else {
warn 'Warning: Input file "' . $ARGV[0] . '" does not exist';
}
}
if ($params{'sequence'}) { # Via --sequence
if (-f $params{'sequence'} || $params{'sequence'} eq '-') { # File
push(@filename_list, $params{'sequence'});
}
else {
warn 'Warning: Input file "'
. $params{'sequence'}
. '" does not exist';
}
}
# Job identifier tracking for parallel execution.
my @jobid_list = ();
my $job_number = 0;
$/ = '>';
foreach my $filename (@filename_list) {
my $INFILE;
if ($filename eq '-') { # STDIN.
open($INFILE, '<-')
or die 'Error: unable to STDIN (' . $! . ')';
}
else { # File.
open($INFILE, '<', $filename)
or die 'Error: unable to open file '
. $filename . ' ('
. $! . ')';
}
while (<$INFILE>) {
my $seq = $_;
$seq =~ s/>$//;
if ($seq =~ m/(\S+)/) {
my $seq_id = $1;
print STDERR "Submitting job for: $seq_id\n"
if ($outputLevel > 0);
$seq = '>' . $seq;
&print_debug_message('multi_submit_job', $seq, 11);
$job_number++;
my $job_id = &submit_job($seq, $seq_id);
my $job_info_str = sprintf('%s %d %d', $job_id, 0, $job_number);
push(@jobid_list, $job_info_str);
}
# Parallel mode, wait for job(s) to finish to free slots.
while ($params{'maxJobs'} > 1
&& scalar(@jobid_list) >= $params{'maxJobs'}) {
&_job_list_poll(\@jobid_list);
print_debug_message('multi_submit_job',
'Remaining jobs: ' . scalar(@jobid_list), 1);
}
}
close $INFILE;
}
# Parallel mode, wait for remaining jobs to finish.
while ($params{'maxJobs'} > 1 && scalar(@jobid_list) > 0) {
&_job_list_poll(\@jobid_list);
print_debug_message('multi_submit_job',
'Remaining jobs: ' . scalar(@jobid_list), 1);
}
print_debug_message('multi_submit_job', 'End', 1);
}
=head2 _job_list_poll()
Poll the status of a list of jobs and fetch results for finished jobs.
while(scalar(@jobid_list) > 0) {
&_job_list_poll(\@jobid_list);
}
=cut
sub _job_list_poll {
print_debug_message('_job_list_poll', 'Begin', 1);
my $jobid_list = shift;
print_debug_message('_job_list_poll', 'Num jobs: ' . scalar(@$jobid_list),
11);
# Loop though job Id list polling job status.
for (my $jobNum = (scalar(@$jobid_list) - 1); $jobNum > -1; $jobNum--) {
my ($jobid, $seq_id, $error_count, $job_number) =
split(/\s+/, $jobid_list->[$jobNum]);
print_debug_message('_job_list_poll', 'jobNum: ' . $jobNum, 12);
print_debug_message('_job_list_poll',
'Job info: ' . $jobid_list->[$jobNum], 12);
# Get job status.
my $job_status = &rest_get_status($jobid);
print_debug_message('_job_list_poll', 'Status: ' . $job_status, 12);
# Fetch results and remove finished/failed jobs from list.
if (
!(
$job_status eq 'RUNNING'
|| $job_status eq 'QUEUED'
|| ($job_status eq 'ERROR'
&& $error_count < $maxErrorStatusCount)
)
) {
if ($job_status eq 'ERROR' || $job_status eq 'FAILED') {
print STDERR
"Warning: job $jobid failed for sequence $job_number: $seq_id\n";
}
# Duplicated getting results.
#&get_results($jobid, $seq_id);
splice(@$jobid_list, $jobNum, 1);
}
else {
# Update error count, increment for new error or clear old errors.
if ($job_status eq 'ERROR') {
$error_count++;
}
elsif ($error_count > 0) {
$error_count--;
}
# Update job tracking info.
my $job_info_str = sprintf('%s %s %d %d',
$jobid, $seq_id, $error_count, $job_number);
$jobid_list->[$jobNum] = $job_info_str;
}
}
print_debug_message('_job_list_poll', 'Num jobs: ' . scalar(@$jobid_list),
11);
print_debug_message('_job_list_poll', 'End', 1);
}
=head2 list_file_submit_job()
Submit multiple jobs using a file containing a list of entry identifiers as
input.
&list_file_submit_job($list_filename)
=cut
sub list_file_submit_job {
print_debug_message('list_file_submit_job', 'Begin', 1);
my $filename = shift;
# Open the file of identifiers.
my $LISTFILE;
if ($filename eq '-') { # STDIN.
open($LISTFILE, '<-')
or die 'Error: unable to STDIN (' . $! . ')';
}
else { # File.
open($LISTFILE, '<', $filename)
or die 'Error: unable to open file ' . $filename . ' (' . $! . ')';
}
# Job identifier tracking for parallel execution.
my @jobid_list = ();
my $job_number = 0;
# Iterate over identifiers, submitting each job
while (<$LISTFILE>) {
my $line = $_;
chomp($line);
if ($line ne '') {
&print_debug_message('list_file_submit_job', 'line: ' . $line, 2);
if ($line =~ m/\w:\w/) {
# Check this is an identifier
my $seq_id = $line;
print STDERR "Submitting job for: $seq_id\n"
if ($outputLevel > 0);
$job_number++;
my $job_id = &submit_job($seq_id, $seq_id);
my $job_info_str =
sprintf('%s %s %d %d', $job_id, $seq_id, 0, $job_number);
push(@jobid_list, $job_info_str);
}
else {
print STDERR
"Warning: line \"$line\" is not recognised as an identifier\n";
}
# Parallel mode, wait for job(s) to finish to free slots.
while ($params{'maxJobs'} > 1
&& scalar(@jobid_list) >= $params{'maxJobs'}) {
&_job_list_poll(\@jobid_list);
print_debug_message('list_file_submit_job',
'Remaining jobs: ' . scalar(@jobid_list), 1);
}
}
}
close $LISTFILE;
# Parallel mode, wait for remaining jobs to finish.
while ($params{'maxJobs'} > 1 && scalar(@jobid_list) > 0) {
&_job_list_poll(\@jobid_list);
print_debug_message('list_file_submit_job',
'Remaining jobs: ' . scalar(@jobid_list), 1);
}
print_debug_message('list_file_submit_job', 'End', 1);
}
=head2 load_data()
Load sequence data from file or option specified on the command-line.
&load_data();
=cut
sub load_data {
print_debug_message('load_data', 'Begin', 1);
my $retSeq;
# Query sequence
if (defined($ARGV[0])) { # Bare option
if (-f $ARGV[0] || $ARGV[0] eq '-') { # File
$retSeq = &read_file($ARGV[0]);
}
else { # DB:ID or sequence
$retSeq = $ARGV[0];
}
}
if ($params{'sequence'}) { # Via --sequence
if (-f $params{'sequence'} || $params{'sequence'} eq '-') { # File
$retSeq = &read_file($params{'sequence'});
}
else { # DB:ID or sequence
$retSeq = $params{'sequence'};
}
}
print_debug_message('load_data', 'End', 1);
return $retSeq;
}
=head2 load_params()
Load job parameters from command-line options.
&load_params();
=cut
sub load_params {
print_debug_message('load_params', 'Begin', 1);
# Pass default values and fix bools (without default value)
if (!$params{'matrix'}) {
$params{'matrix'} = 'BLOSUM62'
}
if (!$params{'gapopen'}) {
$params{'gapopen'} = 11
}
if (!$params{'gapext'}) {
$params{'gapext'} = 1
}
if (!$params{'expthr'}) {