| 1 |
NAME |
| 2 |
Bio::PrimerDesigner - Design PCR Primers using primer3 and epcr |
| 3 |
|
| 4 |
SYNOPSIS |
| 5 |
use Bio::PrimerDesigner; |
| 6 |
|
| 7 |
my $pd = Bio::PrimerDesigner->new; |
| 8 |
|
| 9 |
# |
| 10 |
# Define the DNA sequence, etc. |
| 11 |
# |
| 12 |
my $dna = "CGTGC...TTCGC"; |
| 13 |
my $seqID = "sequence 1"; |
| 14 |
|
| 15 |
# |
| 16 |
# Define design parameters (native primer3 syntax) |
| 17 |
# |
| 18 |
my %params = ( |
| 19 |
PRIMER_NUM_RETURN => 2, |
| 20 |
PRIMER_SEQUENCE_ID => $seqID, |
| 21 |
SEQUENCE => $dna, |
| 22 |
PRIMER_PRODUCT_SIZE => '500-600' |
| 23 |
); |
| 24 |
|
| 25 |
# |
| 26 |
# Or use input aliases |
| 27 |
# |
| 28 |
%param = ( |
| 29 |
num => 2, |
| 30 |
id => $seqID, |
| 31 |
seq => $dna, |
| 32 |
sizerange => '500-600' |
| 33 |
); |
| 34 |
|
| 35 |
# |
| 36 |
# Design primers |
| 37 |
# |
| 38 |
my $results = $pd->design( %params ) or die $pd->error; |
| 39 |
|
| 40 |
# |
| 41 |
# Make sure the design was successful |
| 42 |
# |
| 43 |
if ( !$results->left ) { |
| 44 |
die "No primers found\n", $results->raw_data; |
| 45 |
} |
| 46 |
|
| 47 |
# |
| 48 |
# Get results (single primer set) |
| 49 |
# |
| 50 |
my $left_primer = $results->left; |
| 51 |
my $right_primer = $results->right; |
| 52 |
my $left_tm = $results->lefttm; |
| 53 |
|
| 54 |
# |
| 55 |
# Get results (multiple primer sets) |
| 56 |
# |
| 57 |
my @left_primers = $results->left(1..3); |
| 58 |
my @right_primers = $results->right(1..3); |
| 59 |
my @left_tms = $results->lefttm(1..3); |
| 60 |
|
| 61 |
DESCRIPTION |
| 62 |
Bio::PrimerDesigner provides a low-level interface to the primer3 and |
| 63 |
epcr binary executables and supplies methods to return the results. |
| 64 |
Because primer3 and e-PCR are only available for Unix-like operating |
| 65 |
systems, Bio::PrimerDesigner offers the ability to accessing the primer3 |
| 66 |
binary via a remote server. Local installations of primer3 or e-PCR on |
| 67 |
Unix hosts are also supported. |
| 68 |
|
| 69 |
METHODS |
| 70 |
binary_path |
| 71 |
Gets/sets path to the primer3 binary. |
| 72 |
|
| 73 |
design |
| 74 |
Makes the primer design or e-PCR request. Returns an |
| 75 |
Bio::PrimerDesigner::Result object. |
| 76 |
|
| 77 |
epcr_example |
| 78 |
Run test e-PCR job. Returns an Bio::PrimerDesigner::Results object. |
| 79 |
|
| 80 |
list_aliases |
| 81 |
Lists aliases for primer3 input/output options |
| 82 |
|
| 83 |
list_params |
| 84 |
Lists input options for primer3 or epcr, depending on the context |
| 85 |
|
| 86 |
method |
| 87 |
Gets/sets method of accessing primer3 or epcr binaries. |
| 88 |
|
| 89 |
os_is_unix |
| 90 |
Returns 1 if it looks like the operating system is a Unix variant, |
| 91 |
otherwise returns 0. |
| 92 |
|
| 93 |
primer3_example |
| 94 |
Runs a sample design job for primers. Returns an |
| 95 |
Bio::PrimerDesigner::Results object. |
| 96 |
|
| 97 |
program |
| 98 |
Gets/sets which program to use. |
| 99 |
|
| 100 |
run |
| 101 |
Alias to "design." |
| 102 |
|
| 103 |
url |
| 104 |
Gets/sets the URL for accessing the remote binaries. |
| 105 |
|
| 106 |
verify |
| 107 |
Tests local installations of primer3 or e-PCR to ensure that they are |
| 108 |
working properly. |
| 109 |
|
| 110 |
AUTHORS |
| 111 |
Copyright (C) 2003-2009 Sheldon McKay <[email protected]>, Ken |
| 112 |
Youens-Clark <[email protected]>. |
| 113 |
|
| 114 |
LICENSE |
| 115 |
This program is free software; you can redistribute it and/or modify it |
| 116 |
under the terms of the GNU General Public License as published by the |
| 117 |
Free Software Foundation; version 3 or any later version. |
| 118 |
|
| 119 |
This program is distributed in the hope that it will be useful, but |
| 120 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 121 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General |
| 122 |
Public License for more details. |
| 123 |
|
| 124 |
You should have received a copy of the GNU General Public License along |
| 125 |
with this program; if not, write to the Free Software Foundation, Inc., |
| 126 |
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 127 |
|
| 128 |
SEE ALSO |
| 129 |
Bio::PrimerDesigner::primer3, Bio::PrimerDesigner::epcr. |
| 130 |
|