Usage
DesignSignatures(dbFile, tblName = "Seqs", identifier = "", focusID = NA, type = "melt", resolution = 0.5, levels = 10, enzymes = NULL, minLength = 17, maxLength = 26, maxPermutations = 4, annealingTemp = 64, P = 4e-07, monovalent = 0.07, divalent = 0.003, dNTPs = 8e-04, minEfficiency = 0.8, ampEfficiency = 0.5, numPrimerSets = 100, minProductSize = 70, maxProductSize = 400, kmerSize = 8, searchPrimers = 500, maxDictionary = 20000, primerDimer = 1e-07, pNorm = 1, taqEfficiency = TRUE, processors = 1, verbose = TRUE)
Arguments
dbFile
A SQLite connection object or a character string specifying the path to the database file.
tblName
Character string specifying the table where the DNA sequences are located.
identifier
Optional character string used to narrow the search results to those matching a specific identifier. Determines the target group(s) for which primers will be designed. If "" then all identifiers are selected.
focusID
Optional character string specifying which of the identifier
s will be used in the initial step of designing primers. If NA
(the default), then the identifier
with the most sequence information is used as the focusID
.
type
Character string indicating the type of signature being used to differentiate the PCR products from each group. This should be (an abbreviation of) one of "melt"
, "length"
, or "sequence"
.
resolution
Numeric specifying the ``resolution'' of the experiment, or a vector giving the boundaries of bins. (See details section below.)
levels
Numeric giving the number of ``levels'' that can be distinguished in each bin. (See details section below.)
enzymes
Named character vector providing the cut sites of one or more restriction enzymes. Cut sites must be delineated in the same format as RESTRICTION_ENZYMES
.
minLength
Integer providing the minimum length of primers to consider in the design.
maxLength
Integer providing the maximum length of primers to consider in the design.
maxPermutations
Integer providing the maximum number of permutations allowed in a forward or reverse primer to attain greater coverage of sequences.
annealingTemp
Numeric indicating the desired annealing temperature that will be used in the PCR experiment.
P
Numeric giving the molar concentration of primers in the reaction.
monovalent
The molar concentration of monovalent ([Na] and [K]) ions in solution that will be used to determine a sodium equivalent concentration.
divalent
The molar concentration of divalent ([Mg]) ions in solution that will be used to determine a sodium equivalent concentration.
dNTPs
Numeric giving the molar concentration of free nucleotides added to the solution that will be used to determine a sodium equivalent concentration.
minEfficiency
Numeric giving the minimum efficiency of hybridization desired for the primer set.
ampEfficiency
Numeric giving the minimum efficiency required for theoretical amplification of the primers. Note that ampEfficiency
must be less than or equal to minEfficiency
. Lower values of ampEfficiency
will allow for more PCR products, although very low values are unrealistic experimentally.
numPrimerSets
Integer giving the optimal number of primer sets (forward and reverse primer sets) to design.
minProductSize
Integer giving the minimum number of nucleotides desired in the PCR product.
maxProductSize
Integer giving the maximum number of nucleotides desired in the PCR product.
kmerSize
Integer giving the size of k-mers to use in the preliminary search for potential primers.
searchPrimers
Numeric specifying the number of forward and reverse primers to use in searching for potential PCR products. A lower value will result in a faster search, but potentially neglect some useful primers.
maxDictionary
Numeric giving the maximum number of primers to search for simultaneously in any given step.
primerDimer
Numeric giving the maximum amplification efficiency of potential primer-dimer products.
pNorm
Numeric specifying the power (p > 0) used in calculating the $L\textsuperscript{p}$-norm when scoring primer pairs. By default (p = 1), the score is equivalent to the average difference between pairwise signatures. When p < 1, many small differences will be preferred over fewer large differences, and vise-versa when p > 1. This enables prioritizing primer pairs that will yield a greater number of unique signatures (p < 1), or fewer distinct, but more dissimilar, signatures (p > 1).
taqEfficiency
Logical determining whether to make use of elongation efficiency to increase predictive accuracy for Taq DNA Polymerase amplifying primers with mismatches near the 3' terminus. Note that this should be set to FALSE if using a high-fidelity polymerase with 3' to 5' exonuclease activity.
processors
The number of processors to use, or NULL
to automatically detect and use all available processors.
verbose
Logical indicating whether to display progress.