ORFFinder
ORFFinder in Python. Inspired by NCBI's version: https://www.ncbi.nlm.nih.gov/orffinder/
Finds the open reading frame (6-frame scan) on a given 5' to 3' nucleotide.
Installation:
pip3 install orffinder
Terminal Usage
Three command-line executable commands are available: orffinder-to-gtf orffinder-to-sequence and orffinder-to-gff3.
Documentation for these commands can be retrieved by specifying <command> -h.
API Usage
Import the package
IMPORTANT: Your DNA/RNA strand should always be from the 5' to 3' direction when input!
(Image credit: Khan Academy)
from Bio import SeqIO
from orffinder import orffinder
sequence = SeqIO.read("gene.fasta", "fasta")
orffinder.getORFs(sequence, minimum_length=75, remove_nested=True)
Documentation
getORFs()
Returns the loci of discovered ORFs in a dictionary format.
sequence: sequence in Biopython Seq or String format.
minimum_length: minimum size of ORF in nucleotides. Default: 75
start_codons: recognised 3-base-pair codons for initialisation. Default: ["ATG"]
stop_codons: recognised 3-base pair condons for termination. Default: ["TAA", "TAG", "TGA"]
remove_nested: remove all ORFs completely encased in another. Default: False
trim_trailing: remove ORFs are the edge of the sequence that do not have a defined stop codon. Default: False
getORFNucleotides()
Returns a list of Biopython Seq objects or loci of discovered ORFs with Biopython Seq objects in a dictionary format.
sequence: sequence in Biopython Seq or String format.
return_loci: return the loci together with the nucleotide sequences. Default: False
minimum_length: minimum size of ORF in nucleotides. Default: 75
start_codons: recognised 3-base-pair codons for initialisation. Default: ["ATG"]
stop_codons: recognised 3-base pair condons for termination. Default: ["TAA", "TAG", "TGA"]
remove_nested: remove all ORFs completely encased in another. Default: False
trim_trailing: remove ORFs are the edge of the sequence that do not have a defined stop codon. Default: False
getORFProteins()
Returns a list of Biopython Seq objects or loci of discovered ORFs with Biopython Seq objects in a dictionary format.
sequence: sequence in Biopython Seq or String format.
translation_table: translation table as per BioPython. Default: 1
return_loci: return the loci together with the protein sequences. Default: False
minimum_length: minimum size of ORF in nucleotides. Default: 75
start_codons: recognised 3-base-pair codons for initialisation. Default: ["ATG"]
stop_codons: recognised 3-base pair condons for termination. Default: ["TAA", "TAG", "TGA"]
remove_nested: remove all ORFs completely encased in another. Default: False
trim_trailing: remove ORFs are the edge of the sequence that do not have a defined stop codon. Default: False
Dependencies
Biopython (https://biopython.org/)
Metadata
Release files for orffinder 1.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 | Provenance | Actions |
|---|---|---|---|---|
| orffinder-1.8.tar.gz | 5.6 kB | Without provenance | Details for orffinder-1.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| orffinder-1.8-py3-none-any.whl | Python 3 | none | any | Details for orffinder-1.8-py3-none-any.whl |
Total release size: 14.1 kB
Release files / orffinder-1.8.tar.gz
| Download URL | orffinder-1.8.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1c5a6290122d7806049d57d9637711ab24c64f7a67405a6c61d1295bad237f4c
|
|
BLAKE2b-256 checksum How to use checksums |
620e61528cf7210ce12e84a23ba62f7ef4cffd34bb346752fc6b71019352920c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.23.4 CPython/3.6.4
|
Release files / orffinder-1.8-py3-none-any.whl
| Download URL | orffinder-1.8-py3-none-any.whl |
|---|---|
| Size | 8.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2ae64e3cb7a214c0ee4214fa9bf1f69b8c886da7cd53cbda4b3b5f74efcac229
|
|
BLAKE2b-256 checksum How to use checksums |
05947f3c6146f4c20377c07ef09a44f9237067adff1e37e444a5b5b0b28bdb23
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.23.4 CPython/3.6.4
|
Security for orffinder 1.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.