/
BlastPlus.pm
executable file
·162 lines (114 loc) · 3.84 KB
/
BlastPlus.pm
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
#
# BioPerl module for Bio::Tools::Run::BlastPlus
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Mark A. Jensen <maj -at- fortinbras -dot- us>
#
# Copyright Mark A. Jensen
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::Tools::Run::BlastPlus - A wrapper for NCBI's blast+ suite
=head1 SYNOPSIS
Give standard usage here
=head1 DESCRIPTION
Blast+ is NCBI's successor to the C<blastall> family of programs.
=head1 FEEDBACK
=head2 Mailing Lists
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
=head2 Support
Please direct usage questions or support issues to the mailing list:
L<bioperl-l@bioperl.org>
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
=head2 Reporting Bugs
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
the web:
http://redmine.open-bio.org/projects/bioperl/
=head1 AUTHOR - Mark A. Jensen
Email maj -at- fortinbras -dot- us
Describe contact details here
=head1 CONTRIBUTORS
Additional contributors names and emails here
=head1 APPENDIX
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
=cut
# Let the code begin...
package Bio::Tools::Run::BlastPlus;
use strict;
use warnings;
use lib '../../..';
use Bio::Root::Root;
use Bio::Tools::Run::BlastPlus::Config;
use Bio::Tools::Run::WrapperBase;
use Bio::Tools::Run::WrapperBase::CommandExts;
use base qw(Bio::Tools::Run::WrapperBase Bio::Root::Root);
=head2 new
Title : new
Usage : my $obj = new Bio::Tools::Run::BlastPlus();
Function: Builds a new Bio::Tools::Run::BlastPlus object
Returns : an instance of Bio::Tools::Run::BlastPlus
Args :
=cut
sub new {
my ($class,@args) = @_;
$program_dir ||= $ENV{BLASTPLUSDIR};
my $self = $class->SUPER::new(@args);
return $self;
}
=head2 program_version()
Title : program_version
Usage : $version = $bedtools_fac->program_version()
Function: Returns the program version (if available)
Returns : string representing location and version of the program
Note : this works around the WrapperBase::version() method conflicting with
the -version parameter for SABlast (good argument for not having
getter/setters for these)
=cut
=head2 package_version()
Title : package_version
Usage : $version = $bedtools_fac->version()
Function: Returns the BLAST+ package version (if available)
Returns : string representing BLAST+ package version (may differ from version())
=cut
sub program_version {
my ($self) = @_;
if (!defined $self->{program_version}) {
$self->_version;
}
$self->{program_version} || '';
}
sub package_version {
my ($self) = @_;
if (!defined $self->{package_version}) {
$self->_version;
}
$self->{package_version} || '';
}
sub _version {
my $self = shift;
my ($in, $out, $err);
# Get program executable
my $exe = $self->executable;
my @ipc_args = ( $exe, '-version');
eval {
IPC::Run::run(\@ipc_args, \$in, \$out, \$err) or
die ("There was a problem running $exe : $!");
};
if ($out =~ /blastdbcmd\:\s+(\S+)\n\s*Package\:\s+([^,]+)/xms) {
@{$self}{qw(program_version package_version)} = ($1, $2);
} else {
$self->throw("Unknown version output: $out");
}
}
1;