Skip to main content

A package for generating multiplex PCR primer sets

Project description

This program designs PCR primers for a multiplex of given target regions of a DNA sequence in a FASTA file.

The script takes several arguments:

Parameter Description
region_file (required) The path to the primer design region file. This file should have three columns: name, start position, and end position (1-based). It can be in either tsv or xlxs format.
input_file (required) The path to the input FASTA file.
target_tm The desired melting temperature (Tm) for the primers. Default is 60.
primer_len The desired length of the primers. Default is 20.
product_size_min The desired min size for the PCR product. Default is 400.
product_size_max The desired max size for the PCR product. Default is 800.
ret The maximum number of primer pairs to return. Default is 100.
Q5 A boolean indicating whether to use NEB Q5 hotstart polymerase settings for primer3. Default is True.
background The path to the mispriming library FASTA file. Default is an empty string.
output The name of the output file. Default is 'MultiPlexPrimerSet'.
eval The maximum number of primer sets to evaluate. Default is 10000.

The main function of the script is 'design_primers', which takes the input FASTA file, start and end positions of a target region, and the arguments specified using argparse, and returns the best primer set for that region as a list of dictionaries containing information about the primer pairs.

The 'design_primers' function performs the following steps:

  • Parses the input FASTA file and extracts the target region sequence.
  • Sets up the primer3 input parameters based on the specified arguments.
  • Runs primer3 to design the primers.
  • Extracts information about the primer pairs.
  • Determines the best set of multiplex primers.

Installation

pip install getMultiPrimerSet

Example usage

getMultiPrimerSet --region_file "./example/primer_regions.tsv" --input_file "./example/ref.fasta" --target_tm 65 --primer_len 20 --product_size_min 400 --product_size_max 800 --ret 100 --eval 1000 --Q5 --background "" --output "example"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

getMultiPrimerSet-1.0.2.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

getMultiPrimerSet-1.0.2-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file getMultiPrimerSet-1.0.2.tar.gz.

File metadata

  • Download URL: getMultiPrimerSet-1.0.2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for getMultiPrimerSet-1.0.2.tar.gz
Algorithm Hash digest
SHA256 5d5f95ad0e35fd0edd6f5fae77bfdcb287b15c860503799a6a3093a4c61c7ddc
MD5 3d9e894aa93f3a42cbbcb59fe9be4e54
BLAKE2b-256 0566286405aef25509839c1719d5cd3290645f1cb66222ec9a9d3ae396a193dd

See more details on using hashes here.

File details

Details for the file getMultiPrimerSet-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for getMultiPrimerSet-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6262a5c4e9b722b747c27ed6f02152cc9a51858143cdecc742375a87dddcc814
MD5 fb0049278795fbecfc2493664973f503
BLAKE2b-256 bda84d43a69af34b324ae6e952bc1c931c45fbda354891b3328852f29823c831

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page