| Name | getMultiPrimerSet JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | |
| Summary | A package for generating multiplex PCR primer sets |
| upload_time | 2023-05-08 23:29:35 |
| maintainer | |
| docs_url | None |
| author | Jason D Limberis |
| requires_python | |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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"
```
Raw data
{
"_id": null,
"home_page": "",
"name": "getMultiPrimerSet",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Jason D Limberis",
"author_email": "Jason.Limberis@ucsf.edu",
"download_url": "https://files.pythonhosted.org/packages/05/66/286405aef25509839c1719d5cd3290645f1cb66222ec9a9d3ae396a193dd/getMultiPrimerSet-1.0.2.tar.gz",
"platform": null,
"description": "\nThis program designs PCR primers for a multiplex of given target regions of a DNA sequence in a FASTA file.\n\nThe script takes several arguments:\n\n| Parameter | Description |\n| --- | --- |\n| 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. |\n| input_file (required) | The path to the input FASTA file. |\n| target_tm | The desired melting temperature (Tm) for the primers. Default is 60. |\n| primer_len | The desired length of the primers. Default is 20. |\n| product_size_min | The desired min size for the PCR product. Default is 400. |\n| product_size_max | The desired max size for the PCR product. Default is 800. |\n| ret | The maximum number of primer pairs to return. Default is 100. |\n| Q5 | A boolean indicating whether to use NEB Q5 hotstart polymerase settings for primer3. Default is True. |\n| background | The path to the mispriming library FASTA file. Default is an empty string. |\n| output | The name of the output file. Default is 'MultiPlexPrimerSet'. |\n| eval | The maximum number of primer sets to evaluate. Default is 10000. |\n\nThe 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.\n\nThe 'design_primers' function performs the following steps:\n\n- Parses the input FASTA file and extracts the target region sequence.\n- Sets up the primer3 input parameters based on the specified arguments.\n- Runs primer3 to design the primers.\n- Extracts information about the primer pairs.\n- Determines the best set of multiplex primers.\n\n\n### Installation\n```\npip install getMultiPrimerSet\n```\n\n### Example usage\n```\ngetMultiPrimerSet --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\"\n```\n \n\n",
"bugtrack_url": null,
"license": "",
"summary": "A package for generating multiplex PCR primer sets",
"version": "1.0.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bda84d43a69af34b324ae6e952bc1c931c45fbda354891b3328852f29823c831",
"md5": "fb0049278795fbecfc2493664973f503",
"sha256": "6262a5c4e9b722b747c27ed6f02152cc9a51858143cdecc742375a87dddcc814"
},
"downloads": -1,
"filename": "getMultiPrimerSet-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb0049278795fbecfc2493664973f503",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6490,
"upload_time": "2023-05-08T23:29:32",
"upload_time_iso_8601": "2023-05-08T23:29:32.956774Z",
"url": "https://files.pythonhosted.org/packages/bd/a8/4d43a69af34b324ae6e952bc1c931c45fbda354891b3328852f29823c831/getMultiPrimerSet-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0566286405aef25509839c1719d5cd3290645f1cb66222ec9a9d3ae396a193dd",
"md5": "3d9e894aa93f3a42cbbcb59fe9be4e54",
"sha256": "5d5f95ad0e35fd0edd6f5fae77bfdcb287b15c860503799a6a3093a4c61c7ddc"
},
"downloads": -1,
"filename": "getMultiPrimerSet-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "3d9e894aa93f3a42cbbcb59fe9be4e54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6303,
"upload_time": "2023-05-08T23:29:35",
"upload_time_iso_8601": "2023-05-08T23:29:35.501610Z",
"url": "https://files.pythonhosted.org/packages/05/66/286405aef25509839c1719d5cd3290645f1cb66222ec9a9d3ae396a193dd/getMultiPrimerSet-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-08 23:29:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "getmultiprimerset"
}
