orfdata
orfdata builds protein references for a species from a PyEnsembl annotation: the annotated proteins, plus open reading frames (ORFs) that ribosome-profiling and mass-spectrometry studies found translated outside those annotations, and viral proteins when you ask for them. Each added ORF stays bound to its PyEnsembl transcript, with its source, category and evidence. Its FASTA and GTF outputs open as PyEnsembl genomes, so varcode, isovar, topiary and vaxrank can use them. orfdata also distributes RNA, ribosome and protein measurement datasets for human, mouse, dog and yeast.
Install
python -m pip install orfdata
pyensembl install --release 115 --species human
orfdata setup --species human --catalogs all
orfdata needs Python 3.11 or later. The second command downloads and indexes
Ensembl 115 for human GRCh38. The third builds human's optional Ribo-seq ORF
catalogues from their pinned sources (needed for evidence presets such as
"ms" and for "all"), and downloads the assembly chains and the GDC viral
collection (--collections none skips it). The bundled human ORF catalogue
needs no setup. orfdata never downloads data implicitly: every download is an
explicit command, checked against a pinned checksum.
The canine-extraction extra (pip install 'orfdata[canine-extraction]')
adds APSW, needed only to extract the original canine vendor database.
Quick start
Build the human Ensembl 115 proteome plus the noncanonical ORFs (ncORFs) that have supporting mass-spectrometry peptides, and write it as FASTA:
from pyensembl import EnsemblRelease
from orfdata import ReferenceTranscriptome
genome = EnsemblRelease(115, species="human")
transcriptome = ReferenceTranscriptome.from_genome(genome)
proteome = transcriptome.proteome(nc_orf_sources="ms")
proteome.write_fasta("human-e115.fasta")
print(proteome.summary()["protein_sources"], len(proteome.excluded))
{'reference_cds': 245535, 'nc_orf': 2181} 5
proteome() on its own gives every reference CDS protein, with no ncORFs or
viruses. nc_orf_sources="ms" adds the 2,181 MS-supported ORFs whose exact
coding path an Ensembl 115 transcript carries; the other 5 are in
proteome.excluded with the reason. Other sources include "ribosome",
"all" and named catalogues; viral="HPV16" adds a virus. A translated ORF or
a detected peptide does not by itself establish a stable, functional protein:
most MS support in the bundled human catalogue comes from peptides eluted from
HLA molecules.
Command line
Run orfdata for the command guide, or orfdata help COMMAND for one
command. Tables are the default output; add --json for scripts.
orfdata data list # what can be downloaded or built
orfdata data status # what is installed locally
orfdata data fetch ingolia-yeast-rna-ribo
orfdata query --gene TPST1 # ORFs in the installed catalogue
orfdata proteome --species human --release 115 --nc-orf-sources ms --output human-e115.fasta
orfdata viral summary # installed viral reference layers
orfdata datasets query ingolia-yeast-rna-ribo --limit 5
download and downloads are aliases for data. See the
command-line guide for every command.
Documentation
The documentation covers, in reading order:
- Getting started: install, a first proteome, ncORF evidence presets and supported species.
- Build a reference proteome: evidence filters, excluded ORFs, viral and sample-derived proteins, FASTA headers.
- Discover and download data:
the
orfdata dataworkflow and the cache. - Downstream tools: ncORFs and viral references in varcode, isovar, topiary and vaxrank.
- ORFs and evidence: ORF classes and what each kind of evidence supports.
- Measurements: the quantitative datasets and their query API.
Release notes are in CHANGELOG.md; the data roadmap tracks further species and sources.
Development
python -m pip install -e '.[dev,docs]'
./lint.sh # ruff
./test.sh # pytest
./docs.sh # mkdocs build --strict
Every PR bumps orfdata/version.py and adds a CHANGELOG.md entry.
Maintainers publish with ./deploy.sh from a clean, synchronized main.
License
Apache 2.0. Downloadable datasets keep their sources' own terms and attribution, recorded in each release manifest.
Metadata
Release files for orfdata 0.48.2
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 |
|---|---|---|---|---|
| orfdata-0.48.2.tar.gz | 3.8 MB | Without provenance | Details for orfdata-0.48.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| orfdata-0.48.2-py3-none-any.whl | Python 3 | none | any | Details for orfdata-0.48.2-py3-none-any.whl |
Total release size: 6.1 MB
Release files / orfdata-0.48.2.tar.gz
| Download URL | orfdata-0.48.2.tar.gz |
|---|---|
| Size | 3.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c223f4ffa47df8808bfd01b9d4a747806f817c96c7051d4a88e12bf1781accc9
|
|
BLAKE2b-256 checksum How to use checksums |
1ea0ad572ba730c1a3cd98edc213966d363ecf3a484eced6dcfefab3f6abb558
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.6
|
Release files / orfdata-0.48.2-py3-none-any.whl
| Download URL | orfdata-0.48.2-py3-none-any.whl |
|---|---|
| Size | 2.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
51304ab9a68e620d2c6224ce2e7220522bea26a18d135837bed555cc32375d8a
|
|
BLAKE2b-256 checksum How to use checksums |
2d425584f7a12c039312284cb6a1c868ef5bcd481b2c2b61c7e1a54d0305bd2e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.6
|
Security for orfdata 0.48.2
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.