
                            EMBOSS: primersearch
     _________________________________________________________________
   
                             Program primersearch
                                       
Function

   Searches DNA sequences for matches with primer pairs
   
Description

   primersearch reads in primer pairs from an input file and searches
   them against sequence(s) specified by the user. Each of the primers in
   a pair is searched against the sequence and potential amplimers are
   reported.
   
   The user can specify a maximum percent mismatch level; for example,
   10% mismatch on a primer of length 20bp means that the program will
   classify a primer as matching a sequence if 18 of the 20 base pairs
   matches.
   
   It will only report matches if both primers in the pair have a match
   in opposite orientations.
   
Usage

   Here is a sample session with primersearch:

unix% primersearch embl:Z52466
Searches DNA sequences for matches with primer pairs
Primer file: primers
Output file [hsa203yc1.primersearch]: stdout
Allowed percent mismatch [0]:

Primer name D1S243

Primer name D1S468

Primer name D1S2845

Primer name D1S1608

Primer name D1S2893

Primer name D1S2660
Amplimer 1
        Sequence: HSA203YC1 Z52466
        H.sapiens (D1S2660) DNA segment containing (CA) repeat; clone AFMa203yc
1; single read.
        CACACATGCACATGCAC hits forward strand at 27 with 0 mismatches
        AGTGACACCAGCAGGG hits reverse strand at [103] with 0 mismatches
        Amplimer length: 261 bp

   Here we run the same example but allowing 20% mismatch between the
   primers and the sequence.
   
unix % primersearch embl:Z52466
Searches DNA sequences for matches with primer pairs
Primer file: primers
Output file [hsa203yc1.primersearch]: stdout
Allowed percent mismatch [0]: 20

Primer name D1S243

Primer name D1S468

Primer name D1S2845

Primer name D1S1608

Primer name D1S2893

Primer name D1S2660
Amplimer 1
        Sequence: HSA203YC1 Z52466
        H.sapiens (D1S2660) DNA segment containing (CA) repeat; clone AFMa203yc
1; single read.
        CACACATGCACATGCAC hits forward strand at 49 with 2 mismatches
        AGTGACACCAGCAGGG hits reverse strand at [103] with 0 mismatches
        Amplimer length: 239 bp
Amplimer 2
        Sequence: HSA203YC1 Z52466
        H.sapiens (D1S2660) DNA segment containing (CA) repeat; clone AFMa203yc
1; single read.
        CACACATGCACATGCAC hits forward strand at 27 with 0 mismatches
        AGTGACACCAGCAGGG hits reverse strand at [103] with 0 mismatches
        Amplimer length: 261 bp

   Here is an example of running with a file containing a list of
   sequences.
   
curium % primersearch @seqs.list
Searches DNA sequences for matches with primer pairs
Primer file: primers
Output file [hs214yg7.primersearch]: stdout
Allowed percent mismatch [0]:

Primer name D1S243
Amplimer 1
        Sequence: HS214YG7 Z16979
        H. sapiens (D1S243) DNA segment containing (CA) repeat; clone AFM214yg7
; single read.
        CACACAGGCTCACATGCC hits forward strand at 122 with 0 mismatches
        GCTCCAGCGTCATGGACT hits reverse strand at [36] with 0 mismatches
        Amplimer length: 162 bp

Primer name D1S468
Amplimer 1
        Sequence: HS280WE5 Z23994
        H. sapiens (D1S468) DNA segment containing (CA) repeat; clone AFM280we5
; single read.
        AATTAACCGTTTTGGTCCT hits forward strand at 47 with 0 mismatches
        GCGACACACACTTCCC hits reverse strand at [96] with 0 mismatches
        Amplimer length: 185 bp

Primer name D1S2845
Amplimer 1
        Sequence: HS344WE9 Z51474
        H.sapiens (D1S2845) DNA segment containing (CA) repeat; clone AFM344we9
; single read.
        CCAAAGGGTGCTTCTC hits forward strand at 29 with 0 mismatches
        GTGGCATTCCAACCTC hits reverse strand at [157] with 0 mismatches
        Amplimer length: 201 bp

Primer name D1S1608
Amplimer 1
        Sequence: HS829186 G07829
        human STS CHLC.GATA49A06.P15262 clone GATA49A06, sequence tagged site.
        GATGGCTTTTGGGGACTATT hits forward strand at 13 with 0 mismatches
        CACTGAGCCAAGTGACACAG hits reverse strand at [92] with 0 mismatches
        Amplimer length: 270 bp

Primer name D1S2893
Amplimer 1
        Sequence: HS123XC3 Z50993
        H.sapiens (D1S2893) DNA segment containing (CA) repeat; clone AFM123xc3
; single read.
        AAAACATCAACTCTCCCCTG hits forward strand at 5 with 0 mismatches
        CTCAAACCCCAATAAGCCTT hits reverse strand at [3] with 0 mismatches
        Amplimer length: 215 bp

Primer name D1S2660
Amplimer 1
        Sequence: HSA203YC1 Z52466
        H.sapiens (D1S2660) DNA segment containing (CA) repeat; clone AFMa203yc
1; single read.
        CACACATGCACATGCAC hits forward strand at 27 with 0 mismatches
        AGTGACACCAGCAGGG hits reverse strand at [103] with 0 mismatches
        Amplimer length: 261 bp


Command line arguments

   Mandatory qualifiers:
  [-sequences]         seqall     Sequence database USA
  [-primers]           infile     Primer file
  [-mismatchpercent]   integer    Allowed percent mismatch
  [-out]               outfile    Output file name

   Optional qualifiers: (none)
   Advanced qualifiers: (none)
   General qualifiers:
  -help                bool       report command line options. More
                                  information on associated and general
                                  qualifiers can be found with -help -verbose
   

   Mandatory qualifiers Allowed values Default
   [-sequences]
   (Parameter 1) Sequence database USA Readable sequence(s) Required
   [-primers]
   (Parameter 2) Primer file Input file Required
   [-mismatchpercent]
   (Parameter 3) Allowed percent mismatch Any integer value 0
   [-out]
   (Parameter 4) Output file name Output file <sequence>.primersearch
   Optional qualifiers Allowed values Default
   (none)
   Advanced qualifiers Allowed values Default
   (none)
   
Input file format

   The input primer file used in the example above has the following
   format:
   
   Comment lines start with a '#'
   Lines with primer information have three fields separated by spaces or
   TAB characters. The columns contain:
    1. The name of the primer pair - this is reported in the output.
    2. The sequence of the first primer.
    3. The sequence of the second primer.
       
   Empty files will cause primersearch to note that no primers have been
   found, and to exit.
   
   An example of the primer file follows:
     _________________________________________________________________
   
# This is my primer file
D1S243  cacacaggctcacatgcc      gctccagcgtcatggact
D1S468 aattaaccgttttggtcct     gcgacacacacttccc
D1S2845 ccaaagggtgcttctc        gtggcattccaacctc
D1S1608 gatggcttttggggactatt    cactgagccaagtgacacag
D1S2893 aaaacatcaactctcccctg    ctcaaaccccaataagcctt
D1S2660 cacacatgcacatgcac       agtgacaccagcaggg
     _________________________________________________________________
   
   In the example usage given above, the file 'seqs.list' contains the
   following sequences:
     _________________________________________________________________
   
embl:Z16979
embl:Z23994
embl:Z51474
embl:G07829
embl:Z50993
embl:Z52466
     _________________________________________________________________
   
Output file format

   Here is an exmaple of the output file:
     _________________________________________________________________
   
Primer name D1S243

Primer name D1S468

Primer name D1S2845

Primer name D1S1608

Primer name D1S2893

Primer name D1S2660
Amplimer 1
        Sequence: HSA203YC1 Z52466
        H.sapiens (D1S2660) DNA segment containing (CA) repeat; clone AFMa203yc
1; single read.
        CACACATGCACATGCAC hits forward strand at 27 with 0 mismatches
        AGTGACACCAGCAGGG hits reverse strand at [103] with 0 mismatches
        Amplimer length: 261 bp
     _________________________________________________________________
   
Data files

   None.
   
Notes

   Every potential amplimer will be reported; if one primer matches the
   forward strand twice and the other matches the reverse strand only
   once, two potential amplimers are reported. If the reverse primer
   matches twice, four potential amplimers are reported.
   
   Each primer pair consists of a name, followed by two primer sequences,
   primerA and primerB. The program first compares primerA to the forward
   strand and if it matches, primerB is compared to the reverse strand.
   The approach is then reversed, with the primerB being compared to the
   forward strand and primerA to the reverse. In this way all possible
   amplimers are reported.
   
References

   None.
   
Warnings

   This program is slow.
   Don't try searching all of EMBL!
   It might not be sensible to search all of the human section of EMBL -
   in 2000, this would take a day to do with one primer pair.
   It will take longer with more primer pairs.
   It will take longer if you allow mismatches.
   
Diagnostic Error Messages

   "No suitable primers found - exiting" means that either the primers
   file was empty or there were no compilable primer pairs contained in
   it.
   
Exit status

   It always exits with status 0
   
Known bugs

   None.
   
See also

   Program name Description
   eprimer3 Picks PCR primers and hybridization oligos
   stssearch Searches a DNA database for matches with a set of STS
   primers
   
   stssearch does something similar, but doesn't allow you to find
   mismatches and will report any match in any orientation and doesn't
   require you to have both primers matching.
   
Author(s)

   This application was written by Val Curwen (vcurwen@hgmp.mrc.ac.uk)
   
History

   Written Aug 2000 - Val Curwen
   
Target users

   This program is intended to be used by everyone and everything, from
   naive users to embedded scripts.
   
Comments
