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
2 maintainers
Release files for gumpy 1.3.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gumpy-1.3.8.tar.gz | 47.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gumpy-1.3.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 96.4 kB
Release files / gumpy-1.3.8.tar.gz
| Download URL | gumpy-1.3.8.tar.gz |
|---|---|
| Size | 47.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cab7f7af29d62a1d40b51ccdb2d180433e8fd998020191dff5ea81fb0ec7f189
|
|
BLAKE2b-256 checksum How to use checksums |
7228269f48fddf2c231a3b9504f8407dd6728aaebef5dea7425fbc3fc623290c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
Release files / gumpy-1.3.8-py3-none-any.whl
| Download URL | gumpy-1.3.8-py3-none-any.whl |
|---|---|
| Size | 49.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2de1cb9a2bb18c1880cd0621828d48ec76e75922d60c14a367f83724140075c3
|
|
BLAKE2b-256 checksum How to use checksums |
e716fdc182ceb1a107565ac8ba8e67c020c2a3dd6eb535785b3e027eb687ae5c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.4
|
