[](https://github.com/oxfordmmm/gumpy/actions/workflows/tests.yaml)
[](https://codecov.io/gh/oxfordmmm/gumpy)
[](https://oxfordmmm.github.io/gumpy/)
[](https://badge.fury.io/py/gumpy)
# gumpy
Genetics with Numpy
## Installation
```
git clone https://github.com/oxfordmmm/gumpy
cd gumpy
pip install .
```
## Documentation
https://oxfordmmm.github.io/gumpy/
## Testing
A suite of tests can be run from a terminal:
```
python -m pytest --cov=gumpy -vv
```
## Usage
### Parse a genbank file
Genome objects can be created by passing a filename of a genbank file
```
from gumpy import Genome
g = Genome("filename.gbk")
```
### Parse a VCF file
VCFFile objects can be created by passing a filename of a vcf file
```
from gumpy import VCFFile
vcf = VCFFile("filename.vcf")
```
### Apply a VCF file to a reference genome
The mutations defined in a vcf file can be applied to a reference genome to produce a new Genome object containing the changes detailed in the vcf.
If a contig is set within the vcf, the length of the contig should match the length of the genome. Otherwise, if the vcf details changes within the genome range, they will be made.
```
from gumpy import Genome, VCFFile
reference_genome = Genome("reference.gbk")
vcf = VCFFile("filename.vcf")
resultant_genome = reference_genome + vcf
```
### Genome level comparisons
There are two different methods for comparing changes. One can quickly check for changes which are caused by a given VCF file. The other can check for changes between two genome. The latter is therefore suited best for comparisons in which either both genomes are mutated, or the VCF file(s) are not available. The former is best suited for cases where changes caused by a VCF want to be determined, but finding gene-level differences will require rebuilding the Gene objects, which can be time consuming.
#### Compare genomes
Two genomes of the same length can be easily compared, including equality and changes between the two.
Best suited to cases where two mutated genomes are to be compared.
```
from gumpy import Genome, GenomeDifference
g1 = Genome("filename1.gbk")
g2 = Genome("filename2.gbk")
diff = g2 - g1 #Genome.difference returns a GenomeDifference object
print(diff.snp_distance) #SNP distance between the two genomes
print(diff.variants) #Array of variants (SNPs/INDELs) of the differences between g2 and g1
```
### Gene level comparisons
When a Genome object is instanciated, it is populated with Gene objects for each gene detailed in the genbank file.
These genes can also be compared.
Gene differences can be found through direct comparison of Gene objects, or systematically through the `gene_differences()` method of `GenomeDifference`.
```
from gumpy import Genome, Gene
g1 = Genome("filename1.gbk")
g2 = Genome("filename2.gbk")
#Get the Gene objects for the gene "gene1_name" from both Genomes
g1_gene1 = g1.build_gene["gene1_name"]
g2_gene1 = g2.build_gene["gene1_name"]
g1_gene1 == g2_gene1 #Equality check of the two genes
diff= g1_gene1 - g2_gene1 #Returns a GeneDifference object
diff.mutations #List of mutations in GARC describing the variation between the two genes
```
### Save and load Genome objects
Due to how long it takes to create a Genome object, it may be beneficial to save the object to disk. The reccomendation is to utilise the `pickle` module to do so, but due to the security implications of this, do so at your own risk! An example is below:
```
import pickle
import gumpy
#Load genome
g = gumpy.Genome("filename.gbk")
#Save genome
pickle.dump(g, open("filename.pkl", "wb"))
#Load genome
g2 = pickle.load(open("filename.pkl", "rb"))
g == g2 #True
```
Raw data
{
"_id": null,
"home_page": "https://github.com/oxfordmmm/gumpy",
"name": "gumpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Philip W Fowler",
"author_email": "philip.fowler@ndm.ox.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/68/d6/67e066e3ec076622d7e5f3516a1f437e06b8952d0691c4fdc0e6ef8318b4/gumpy-1.3.2.tar.gz",
"platform": null,
"description": "[](https://github.com/oxfordmmm/gumpy/actions/workflows/tests.yaml)\n[](https://codecov.io/gh/oxfordmmm/gumpy) \n[](https://oxfordmmm.github.io/gumpy/)\n[](https://badge.fury.io/py/gumpy)\n\n# gumpy\nGenetics with Numpy\n\n## Installation\n```\ngit clone https://github.com/oxfordmmm/gumpy\ncd gumpy\npip install .\n```\n## Documentation\nhttps://oxfordmmm.github.io/gumpy/\n\n## Testing\nA suite of tests can be run from a terminal:\n```\npython -m pytest --cov=gumpy -vv\n```\n\n## Usage\n### Parse a genbank file\nGenome objects can be created by passing a filename of a genbank file\n```\nfrom gumpy import Genome\n\ng = Genome(\"filename.gbk\")\n```\n\n### Parse a VCF file\nVCFFile objects can be created by passing a filename of a vcf file\n```\nfrom gumpy import VCFFile\n\nvcf = VCFFile(\"filename.vcf\")\n```\n\n### Apply a VCF file to a reference genome\nThe mutations defined in a vcf file can be applied to a reference genome to produce a new Genome object containing the changes detailed in the vcf.\n\nIf a contig is set within the vcf, the length of the contig should match the length of the genome. Otherwise, if the vcf details changes within the genome range, they will be made.\n```\nfrom gumpy import Genome, VCFFile\n\nreference_genome = Genome(\"reference.gbk\")\nvcf = VCFFile(\"filename.vcf\")\n\nresultant_genome = reference_genome + vcf\n```\n\n### Genome level comparisons\nThere are two different methods for comparing changes. One can quickly check for changes which are caused by a given VCF file. The other can check for changes between two genome. The latter is therefore suited best for comparisons in which either both genomes are mutated, or the VCF file(s) are not available. The former is best suited for cases where changes caused by a VCF want to be determined, but finding gene-level differences will require rebuilding the Gene objects, which can be time consuming.\n\n#### Compare genomes\nTwo genomes of the same length can be easily compared, including equality and changes between the two.\nBest suited to cases where two mutated genomes are to be compared.\n```\nfrom gumpy import Genome, GenomeDifference\n\ng1 = Genome(\"filename1.gbk\")\ng2 = Genome(\"filename2.gbk\")\n\ndiff = g2 - g1 #Genome.difference returns a GenomeDifference object\nprint(diff.snp_distance) #SNP distance between the two genomes\nprint(diff.variants) #Array of variants (SNPs/INDELs) of the differences between g2 and g1\n```\n\n### Gene level comparisons\nWhen a Genome object is instanciated, it is populated with Gene objects for each gene detailed in the genbank file.\nThese genes can also be compared.\nGene differences can be found through direct comparison of Gene objects, or systematically through the `gene_differences()` method of `GenomeDifference`.\n```\nfrom gumpy import Genome, Gene\n\ng1 = Genome(\"filename1.gbk\")\ng2 = Genome(\"filename2.gbk\")\n\n#Get the Gene objects for the gene \"gene1_name\" from both Genomes\ng1_gene1 = g1.build_gene[\"gene1_name\"]\ng2_gene1 = g2.build_gene[\"gene1_name\"]\n\ng1_gene1 == g2_gene1 #Equality check of the two genes\ndiff= g1_gene1 - g2_gene1 #Returns a GeneDifference object\ndiff.mutations #List of mutations in GARC describing the variation between the two genes\n```\n\n### Save and load Genome objects\nDue to how long it takes to create a Genome object, it may be beneficial to save the object to disk. The reccomendation is to utilise the `pickle` module to do so, but due to the security implications of this, do so at your own risk! An example is below:\n```\nimport pickle\n\nimport gumpy\n\n#Load genome\ng = gumpy.Genome(\"filename.gbk\")\n\n#Save genome\npickle.dump(g, open(\"filename.pkl\", \"wb\"))\n\n#Load genome\ng2 = pickle.load(open(\"filename.pkl\", \"rb\"))\n\ng == g2 #True\n```\n",
"bugtrack_url": null,
"license": "University of Oxford, see LICENSE.md",
"summary": "Genetics with Numpy",
"version": "1.3.2",
"project_urls": {
"Homepage": "https://github.com/oxfordmmm/gumpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3f5f75b6a852d4515337f739fc52907e4f1f4cbdff155e124b9bbd2118821a6",
"md5": "4d575fa3e55cee9f55ba2fb8217b8951",
"sha256": "1b57b4c7a617a06f13188f9b0bcd9fb4e6b4921d33e6ad2a7283c5d641d1eed0"
},
"downloads": -1,
"filename": "gumpy-1.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4d575fa3e55cee9f55ba2fb8217b8951",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 48750,
"upload_time": "2024-06-28T12:41:19",
"upload_time_iso_8601": "2024-06-28T12:41:19.558956Z",
"url": "https://files.pythonhosted.org/packages/b3/f5/f75b6a852d4515337f739fc52907e4f1f4cbdff155e124b9bbd2118821a6/gumpy-1.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "68d667e066e3ec076622d7e5f3516a1f437e06b8952d0691c4fdc0e6ef8318b4",
"md5": "65c21504a22a7041c70899208dc44f1e",
"sha256": "36253ec2bf481022d12eeaa454356733d2a7f4aedcb8ef9315d975f85165e623"
},
"downloads": -1,
"filename": "gumpy-1.3.2.tar.gz",
"has_sig": false,
"md5_digest": "65c21504a22a7041c70899208dc44f1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 47077,
"upload_time": "2024-06-28T12:41:20",
"upload_time_iso_8601": "2024-06-28T12:41:20.956110Z",
"url": "https://files.pythonhosted.org/packages/68/d6/67e066e3ec076622d7e5f3516a1f437e06b8952d0691c4fdc0e6ef8318b4/gumpy-1.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-28 12:41:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oxfordmmm",
"github_project": "gumpy",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "pysam",
"specs": []
},
{
"name": "biopython",
"specs": []
},
{
"name": "tqdm",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "scipy",
"specs": []
}
],
"lcname": "gumpy"
}
JSON
