PrimerDesigner.pm

filter: Statementstmt 74.2% 78 / 105 Branchbran 61.2% 38 / 62 Conditioncond 53.8% 21 / 39 MC/DCmcdc 20.8% 5 / 24 Subroutinesub 68.4% 13 / 19 Podpod 100% 13 / 13 totaltotal 64.1% 168 / 262 CC 46 SCAR 21.5
CC
46
Cov
67%
design
30.0
verify
12.0
method
8.9
CRAP 8.6
« PrimerDesigner/Remote.pm ↑ Summary PrimerDesigner/Result.pm »
1 package Bio::PrimerDesigner;
2  
3 # $Id: PrimerDesigner.pm 25 2008-11-10 20:22:18Z kyclark $
4  
5 =head1 NAME
6  
7 Bio::PrimerDesigner - Design PCR Primers using primer3 and epcr
8  
9 =head1 SYNOPSIS
10  
11 use Bio::PrimerDesigner;
12  
13 my $pd = Bio::PrimerDesigner->new;
14  
15 #
16 # Define the DNA sequence, etc.
17 #
18 my $dna = "CGTGC...TTCGC";
19 my $seqID = "sequence 1";
20  
21 #
22 # Define design parameters (native primer3 syntax)
23 #
24 my %params = (
25 PRIMER_NUM_RETURN => 2,
26 PRIMER_SEQUENCE_ID => $seqID,
27 SEQUENCE => $dna,
28 PRIMER_PRODUCT_SIZE => '500-600'
29 );
30  
31 #
32 # Or use input aliases
33 #
34 %param = (
35 num => 2,
36 id => $seqID,
37 seq => $dna,
38 sizerange => '500-600'
39 );
40  
41 #
42 # Design primers
43 #
44 my $results = $pd->design( %params ) or die $pd->error;
45  
46 #
47 # Make sure the design was successful
48 #
49 if ( !$results->left ) {
50 die "No primers found\n", $results->raw_data;
51 }
52  
53 #
54 # Get results (single primer set)
55 #
56 my $left_primer = $results->left;
57 my $right_primer = $results->right;
58 my $left_tm = $results->lefttm;
59  
60 #
61 # Get results (multiple primer sets)
62 #
63 my @left_primers = $results->left(1..3);
64 my @right_primers = $results->right(1..3);
65 my @left_tms = $results->lefttm(1..3);
66  
67 =head1 DESCRIPTION
68  
69 Bio::PrimerDesigner provides a low-level interface to the primer3 and
70 epcr binary executables and supplies methods to return the results.
71 Because primer3 and e-PCR are only available for Unix-like operating
72 systems, Bio::PrimerDesigner offers the ability to accessing the
73 primer3 binary via a remote server. Local installations of primer3 or
74 e-PCR on Unix hosts are also supported.
75  
76 =head1 METHODS
77  
78 =cut
79  
80 6 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
81 6 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
82 6 ▶use Bio::PrimerDesigner::primer3;
Subroutine BEGIN: called CC=1 SCAR=0.0
83 6 ▶use Bio::PrimerDesigner::epcr;
Subroutine BEGIN: called CC=1 SCAR=0.0
84 6 ▶use Readonly;
Subroutine BEGIN: called CC=1 SCAR=0.0
85  
86 6 ▶use base 'Class::Base';
Subroutine BEGIN: called CC=1 SCAR=0.0
87  
88 6 Readonly my $EMPTY_STR => q{};
89 6 Readonly my %DEFAULT => (
90 method => 'local',
91 binary_path => '/usr/local/bin',
92 program => 'primer3',
93 url
94 => 'http://aceserver.biotech.ubc.ca/cgi-bin/primer_designer.cgi',
95 );
96 6 Readonly my %DESIGNER => (
97 primer3 => 'Bio::PrimerDesigner::primer3',
98 epcr => 'Bio::PrimerDesigner::epcr',
99 );
100 6 Readonly our
101 $VERSION => '0.04'; # must break like this for Module::Build to find
102  
103 # -------------------------------------------------------------------
104 6 ▶sub init {
Subroutine init: called CC=8 SCAR=21.3
Pod documented
105 6 my ( $self, $config ) = @_;
106  
107 6 for my $param ( qw[ program method url ] ) {
108 18 ▶ $self->$param( $config->{ $param } ) or return;
Branch: 1 branch
BranchTrueFalseTotal
$self->$param($config->{$param}) or return 18 0 18
109 }
110  
111 6 ▶ if ($self->method eq 'local') {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->method eq "local") 5 1 6
112 5 ▶ $self->binary_path( $config->{'binary_path'} ) or return;
Branch: 1 branch
BranchTrueFalseTotal
$self->binary_path($config->{"binary_path"}) or return 5 0 5
113 }
114  
115 6 ▶ my $loc = $self->method eq 'local' ? 'path' : 'url';
Branch: 1 branch
BranchTrueFalseTotal
$self->method eq 'local' ? : 5 1 6
116 6 ▶ $self->{ $loc } = $config->{'path'} || $config->{'url'} || $EMPTY_STR;
Condition66%4/6
$config->{'path'} || $config->{'url'} || $EMPTY_STR
l!l&&r!l&&!r
105
$config->{"path"} or $config->{"url"}
l!l&&r!l&&!r
015
MC/DC33%1/3
$config->{'path'} || $config->{'url'} || $EMPTY_STR
$config->{"path"} $config->{"url"} $EMPTY_STR
Truth table50%2/4
A or B || C
A= $config->{"path"}B= $config->{"url"}C= $EMPTY_STR
ABCresult
1XX1
01X1
0011
0000
117 6 return $self;
118 }
119  
120 # -------------------------------------------------------------------
121 9 ▶sub binary_path {
Subroutine binary_path: called CC=6 SCAR=18.1
Pod documented
122  
123 =pod
124  
125 =head2 binary_path
126  
127 Gets/sets path to the primer3 binary.
128  
129 =cut
130  
131 9 my $self = shift;
132  
133 9 ▶ if ( my $path = shift ) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $path = shift()) 2 7 9
134 2 ▶ if ( ! $self->os_is_unix ) {
Branch: 1 branch
BranchTrueFalseTotal
if (not $self->os_is_unix) { } 0 2 2
135 0 return $self->error("Cannot set binary_path on non-Unix-like OS");
136 }
137 else {
138 2 ▶ if ( -e $path ) {
Branch: 1 branch
BranchTrueFalseTotal
if (-e $path) { } 1 1 2
139 1 $self->{'binary_path'} = $path;
140 }
141 else {
142 1 $self->error(
143 "Can't find path to " . $self->program->binary_name .
144 ":\nPath '$path' does not exist"
145 );
146 1 return $EMPTY_STR;
147 }
148 }
149 }
150  
151 8 ▶ unless ( defined $self->{'binary_path'} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->{"binary_path"}) 5 3 8
152 $self->{'binary_path'} =
153 5 ▶ ( $self->os_is_unix ) ? $DEFAULT{'binary_path'} : $EMPTY_STR;
Branch: 1 branch
BranchTrueFalseTotal
$self->os_is_unix ? : 5 0 5
154 }
155  
156 8 return $self->{'binary_path'};
157 }
158  
159 # -------------------------------------------------------------------
160 0 ▶sub design {
Subroutine design: not called CC=5 SCAR=34.0
Pod documented
161  
162 =pod
163  
164 =head2 design
165  
166 Makes the primer design or e-PCR request. Returns an
167 Bio::PrimerDesigner::Result object.
168  
169 =cut
170  
171 0 my $self = shift;
172 0 ▶ my %params = @_ or $self->error("no design parameters");
Branch: 1 branch
BranchTrueFalseTotal
my(%params) = or $self->error("no design parameters") 0 0 0
173 0 my $designer = $self->{'program'};
174 0 my $method = $self->method;
175 0 ▶ my $loc = $method eq 'local' ? $self->binary_path : $self->url;
Branch: 1 branch
BranchTrueFalseTotal
$method eq 'local' ? : 0 0 0
176 0 ▶ my $function = $designer =~ /primer3/ ? 'design' : 'run';
Branch: 1 branch
BranchTrueFalseTotal
$designer =~ /primer3/ ? : 0 0 0
177
178 0 ▶ my $result = $designer->$function( $method, $loc, \%params )
Branch: 1 branch
BranchTrueFalseTotal
my $result = $designer->$function($method, $loc, \%params) or return $self->error($designer->error) 0 0 0
179 or return $self->error( $designer->error );
180
181 0 return $result;
182 }
183  
184 # -------------------------------------------------------------------
185 0 ▶sub epcr_example {
Subroutine epcr_example: not called CC=2 SCAR=17.9
Pod documented
186  
187 =head2 epcr_example
188  
189 Run test e-PCR job. Returns an Bio::PrimerDesigner::Results object.
190  
191 =cut
192  
193 0 my $self = shift;
194 0 my $epcr = Bio::PrimerDesigner::epcr->new;
195 0 ▶ return $epcr->verify( 'remote', $DEFAULT{'url'} )
Condition0%0/3
$epcr->verify('remote', $DEFAULT{'url'}) || $self->error($epcr->error)
l!l&&r!l&&!r
000
MC/DC0%0/2
$epcr->verify('remote', $DEFAULT{'url'}) || $self->error($epcr->error)
$epcr->verify('remote', $DEFAULT{'url'}) $self->error($epcr->error)
Truth table0%0/3
A || B
A= $epcr->verify('remote', $DEFAULT{'url'})B= $self->error($epcr->error)
ABresult
1X1
011
000
196 || $self->error( $epcr->error );
197 }
198  
199 # -------------------------------------------------------------------
200 0 ▶sub list_aliases {
Subroutine list_aliases: not called CC=2 SCAR=17.9
Pod documented
201  
202 =pod
203  
204 =head2 list_aliases
205  
206 Lists aliases for primer3 input/output options
207  
208 =cut
209  
210 0 my $self = shift;
211 0 ▶ my $designer = $self->program or return $self->error;
Branch: 1 branch
BranchTrueFalseTotal
my $designer = $self->program or return $self->error 0 0 0
212 0 return $designer->list_aliases;
213 }
214  
215 # -------------------------------------------------------------------
216 0 ▶sub list_params {
Subroutine list_params: not called CC=2 SCAR=17.9
Pod documented
217  
218 =pod
219  
220 =head2 list_params
221  
222 Lists input options for primer3 or epcr, depending on the context
223  
224 =cut
225  
226 0 my $self = shift;
227 0 ▶ my $designer = $self->program or return $self->error;
Branch: 1 branch
BranchTrueFalseTotal
my $designer = $self->program or return $self->error 0 0 0
228 0 return $designer->list_params;
229 }
230  
231 # -------------------------------------------------------------------
232 23 ▶sub method {
Subroutine method: called CC=8 SCAR=21.8
Pod documented
233  
234 =pod
235  
236 =head2 method
237  
238 Gets/sets method of accessing primer3 or epcr binaries.
239  
240 =cut
241  
242 23 my $self = shift;
243  
244 23 ▶ if ( my $arg = lc shift ) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $arg = lc shift()) 3 20 23
245 3 ▶ return $self->error("Invalid argument for method: '$arg'")
Branch: 1 branch
BranchTrueFalseTotal
unless $arg eq "local" or $arg eq "remote" 1 2 3
Condition66%2/3
$arg eq "local" or $arg eq "remote"
l!l&&r!l&&!r
021
MC/DC50%1/2
$arg eq "local" or $arg eq "remote"
$arg eq "local" $arg eq "remote"
Truth table66%2/3
A or B
A= $arg eq "local"B= $arg eq "remote"
ABresult
1X1
011
000
246 unless $arg eq 'local' || $arg eq 'remote';
247  
248 2 ▶ if ( !$self->os_is_unix && $arg eq 'local' ) {
Branch: 1 branch
BranchTrueFalseTotal
if (not $self->os_is_unix and $arg eq "local") 0 2 2
Condition33%1/3
not $self->os_is_unix and $arg eq "local"
!ll&&!rl&&r
200
MC/DC0%0/2
not $self->os_is_unix and $arg eq "local"
not $self->os_is_unix $arg eq "local"
Truth table33%1/3
not(A) and B
A= not $self->os_is_unixB= $arg eq "local"
ABresult
0X0
100
111
249 0 return $self->error("Local method doesn't work on Windows");
250 }
251  
252 2 $self->{'method'} = $arg;
253 }
254  
255 22 ▶ unless ( defined $self->{'method'} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->{"method"}) 5 17 22
256 5 ▶ $self->{'method'} = $self->os_is_unix ? $DEFAULT{'method'} : 'remote';
Branch: 1 branch
BranchTrueFalseTotal
$self->os_is_unix ? : 5 0 5
257 }
258  
259 22 return $self->{'method'};
260 }
261  
262 # -------------------------------------------------------------------
263 14 ▶sub os_is_unix {
Subroutine os_is_unix: called CC=3 SCAR=11.0
Pod documented
264  
265 =pod
266  
267 =head2 os_is_unix
268  
269 Returns 1 if it looks like the operating system is a Unix variant,
270 otherwise returns 0.
271  
272 =cut
273  
274 14 my $self = shift;
275  
276 # technically, this should be 'os_is_not_windows'
277 14 ▶ unless ( defined $self->{'os_is_unix'} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->{"os_is_unix"}) 6 8 14
278 #$self->{'os_is_unix'} = ( $^O =~ /(n[iu]x|darwin)/ ) ? 1 : 0;
279 6 ▶ $self->{'os_is_unix'} = ( $^O !~ /^MSWin/i ) ? 1 : 0;
Branch: 1 branch
BranchTrueFalseTotal
!($^O =~ /^MSWin/i) ? : 6 0 6
280 }
281  
282 14 return $self->{'os_is_unix'};
283 }
284  
285 # -------------------------------------------------------------------
286 2 ▶sub primer3_example {
Subroutine primer3_example: called CC=2 SCAR=7.6
Pod documented
287  
288 =head2 primer3_example
289  
290 Runs a sample design job for primers. Returns an
291 Bio::PrimerDesigner::Results object.
292  
293 =cut
294  
295 2 my $self = shift;
296 2 my $pcr = Bio::PrimerDesigner::primer3->new;
297 2 ▶ return $pcr->example || $self->error( $pcr->error );
Condition33%1/3
$pcr->example || $self->error($pcr->error)
l!l&&r!l&&!r
200
MC/DC0%0/2
$pcr->example || $self->error($pcr->error)
$pcr->example $self->error($pcr->error)
Truth table33%1/3
A || B
A= $pcr->exampleB= $self->error($pcr->error)
ABresult
1X1
011
000
298 }
299  
300 # -------------------------------------------------------------------
301 14 ▶sub program {
Subroutine program: called CC=8 SCAR=20.9
Pod documented
302  
303 =pod
304  
305 =head2 program
306  
307 Gets/sets which program to use.
308  
309 =cut
310  
311 14 my $self = shift;
312 14 ▶ my $program = shift || $EMPTY_STR;
Condition66%2/3
shift() || $EMPTY_STR
l!l&&r!l&&!r
509
MC/DC50%1/2
shift() || $EMPTY_STR
shift() $EMPTY_STR
Truth table66%2/3
A || B
A= shift()B= $EMPTY_STR
ABresult
1X1
011
000
313 14 my $reset = 0;
314  
315 14 ▶ if ( $program ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($program) 5 9 14
316 return $self->error("Invalid argument for program: '$program'")
317 5 ▶ unless $DESIGNER{ $program };
Branch: 1 branch
BranchTrueFalseTotal
unless $DESIGNER{$program} 1 4 5
318 4 $reset = 1;
319 }
320  
321 13 ▶ if ( $reset || !defined $self->{'program'} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($reset or not defined $self->{"program"}) 9 4 13
Condition100%3/3
$reset or not defined $self->{"program"}
l!l&&r!l&&!r
454
MC/DC100%2/2
$reset or not defined $self->{"program"}
$reset not defined $self->{"program"}
Truth table100%3/3
A or not(B)
A= $resetB= not defined $self->{"program"}
ABresult
1X1
011
000
322 9 ▶ $program ||= $DEFAULT{'program'};
Condition66%2/3
$program ||= $DEFAULT{"program"}
l!l&&r!l&&!r
450
MC/DC0%0/2
$program ||= $DEFAULT{"program"}
$program $DEFAULT{"program"}
Truth table66%2/3
A ||= B
A= $programB= $DEFAULT{"program"}
ABresult
1X1
011
000
323 9 my $class = $DESIGNER{ $program };
324 9 ▶ $self->{'program'} = $class->new or
Branch: 1 branch
BranchTrueFalseTotal
$self->{"program"} = $class->new or return $self->error($class->error) 9 0 9
325 return $self->error( $class->error );
326 }
327  
328 13 return $self->{'program'};
329 }
330  
331 # -------------------------------------------------------------------
332 0 ▶sub run {
Subroutine run: not called CC=1 SCAR=6.9
Pod documented
333  
334 =pod
335  
336 =head2 run
337  
338 Alias to "design."
339  
340 =cut
341 0 my $self = shift;
342 0 return $self->design( @_ );
343 }
344  
345 # -------------------------------------------------------------------
346 8 ▶sub url {
Subroutine url: called CC=8 SCAR=21.5
Pod documented
347  
348 =pod
349  
350 =head2 url
351  
352 Gets/sets the URL for accessing the remote binaries.
353  
354 =cut
355  
356 8 my $self = shift;
357 8 my $url = shift;
358  
359 8 ▶ if ( defined $url && $url eq $EMPTY_STR ) {
Branch: 2 branches
BranchTrueFalseTotal
if (defined $url and $url eq $EMPTY_STR) { } 0 8 8
elsif ($url) { } 2 6 8
Condition66%2/3
defined $url and $url eq $EMPTY_STR
!ll&&!rl&&r
620
MC/DC0%0/2
defined $url and $url eq $EMPTY_STR
defined $url $url eq $EMPTY_STR
Truth table66%2/3
A and B
A= defined $urlB= $url eq $EMPTY_STR
ABresult
0X0
100
111
360 0 $self->{'url'} = $EMPTY_STR;
361 }
362 elsif ( $url ) {
363 2 ▶ $url = 'http://' . $url unless $url =~ m{https?://};
Branch: 1 branch
BranchTrueFalseTotal
unless $url =~ m[https?://] 1 1 2
364 2 $self->{'url'} = $url;
365 }
366  
367 8 eval { require Bio::PrimerDesigner::Config };
368 8 my $local_url = $EMPTY_STR;
369 8 ▶ if ( !$@ ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($@) 8 0 8
370 8 $local_url = $Bio::PrimerDesigner::Config->{'local_url'};
371 }
372  
373 8 ▶ return $self->{'url'} || $local_url || $DEFAULT{'url'};
Condition66%4/6
$self->{'url'} || $local_url || $DEFAULT{'url'}
l!l&&r!l&&!r
350
$self->{"url"} or $local_url
l!l&&r!l&&!r
305
MC/DC0%0/3
$self->{'url'} || $local_url || $DEFAULT{'url'}
$self->{"url"} $local_url $DEFAULT{'url'}
Truth table50%2/4
A or B || C
A= $self->{"url"}B= $local_urlC= $DEFAULT{'url'}
ABCresult
1XX1
01X1
0011
0000
374 }
375  
376 # -------------------------------------------------------------------
377 0 ▶sub verify {
Subroutine verify: not called CC=3 SCAR=24.8
Pod documented
378
379 =head2 verify
380  
381 Tests local installations of primer3 or e-PCR to ensure that they are
382 working properly.
383  
384 =cut
385  
386 0 my $self = shift;
387 0 my $designer = $self->{'program'};
388 0 my $method = $self->method;
389 0 ▶ my $loc = $method eq 'local' ? $self->binary_path : $self->url;
Branch: 1 branch
BranchTrueFalseTotal
$method eq 'local' ? : 0 0 0
390 0 ▶ return $designer->verify( $method, $loc ) ||
Condition0%0/3
$designer->verify($method, $loc) || $self->error($designer->error)
l!l&&r!l&&!r
000
MC/DC0%0/2
$designer->verify($method, $loc) || $self->error($designer->error)
$designer->verify($method, $loc) $self->error($designer->error)
Truth table0%0/3
A || B
A= $designer->verify($method, $loc)B= $self->error($designer->error)
ABresult
1X1
011
000
391 $self->error( $designer->error );
392 }
393  
394 6 1;
395  
396 # -------------------------------------------------------------------
397  
398 =pod
399  
400 =head1 AUTHORS
401  
402 Copyright (C) 2003-2009 Sheldon McKay E<lt>mckays@cshl.eduE<gt>,
403 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
404  
405 =head1 LICENSE
406  
407 This program is free software; you can redistribute it and/or modify
408 it under the terms of the GNU General Public License as published by
409 the Free Software Foundation; version 3 or any later version.
410  
411 This program is distributed in the hope that it will be useful, but
412 WITHOUT ANY WARRANTY; without even the implied warranty of
413 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
414 General Public License for more details.
415  
416 You should have received a copy of the GNU General Public License
417 along with this program; if not, write to the Free Software
418 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
419 USA.
420  
421 =head1 SEE ALSO
422  
423 Bio::PrimerDesigner::primer3, Bio::PrimerDesigner::epcr.
424  
425 =cut
« PrimerDesigner/Remote.pm ↑ Summary PrimerDesigner/Result.pm »