Skip to main content

Tests PyPI

orfdata

orfdata builds the protein reference for a species: the proteins annotated in a PyEnsembl genome, plus open reading frames (ORFs) that ribosome-profiling studies found translated outside those annotations. These include upstream and downstream ORFs, ORFs in other reading frames of a coding sequence, and ORFs on RNAs annotated as noncoding. Each added ORF stays bound to its PyEnsembl transcript, with its source, category and evidence.

Installation

Use Python 3.11 or later. Install orfdata and one PyEnsembl annotation:

python -m pip install 'orfdata[pyensembl]'
pyensembl install --release 115 --species human

Example

from pyensembl import EnsemblRelease
from orfdata import Proteome

genome = EnsemblRelease(115, species="human")
proteome = Proteome.from_genome(genome).with_extra_orfs(evidence="ms")
proteome.write_fasta("human-e115.fasta")
print(proteome.summary()["kinds"], len(proteome.excluded))
{'annotated': 245535, 'extra_orf': 2181} 5

This takes every protein in the Ensembl 115 annotation and adds the 2,181 bundled human ORFs that have supporting mass-spectrometry peptides and are encoded by an Ensembl 115 transcript. Each entry lists every transcript encoding it; the other 5 selected ORFs are listed in proteome.excluded with the reason. Use evidence="ribosome" for all 7,239 encoded ribosome-profiling ORFs, or a rule such as RiboSeq(min_studies=2) & MS() to set Ribo-seq and MS stringency separately (1,293 encoded ORFs). proteome.save(path) writes a checksummed snapshot that Proteome.load reads offline. From the command line:

orfdata proteome --species human --release 115 --output human-e115.fasta

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 immunopeptidomics: peptides eluted from HLA molecules.

Species

Species Noncanonical ORFs Sources
Human 7,264 bundled; 57,607 with catalogs="all" GENCODE; optionally Chang et al. 2025 and Yang et al. 2024 Ribo-seq
Mouse 48,805 Chang et al. and Yang et al. Ribo-seq, OpenProt 2.2 MS
Zebrafish 9,759 Yang et al. Ribo-seq
C. elegans 2,849 Yang et al. Ribo-seq
Yeast 1,128 Yang et al. Ribo-seq
Dog none: no public dog Ribo-seq or ncORF MS exists

Human's bundled catalogue needs no setup. For the others, pip install "orfdata[data,build-data]", then orfdata setup --species mouse (or zebrafish, worm, yeast, or human --catalogs all) builds the catalogues from their sources' own files (details). After orfdata chains download (add --accept-terms for UCSC's non-commercial mouse chains), older assemblies (GRCh37, NCBI36, GRCm38, NCBIM37) and T2T-CHM13 use these catalogues lifted to them; orfdata genomes install t2t-chm13 installs a CHM13 annotation. Dog proteomes contain their PyEnsembl-annotated proteins. load_catalog(species=...) and with_extra_orfs() pick the catalogue for a species and raise when none is available or built. Human evidence is never transferred to another species. Viral proteomes can be added with with_viral(...), but only to a proteome for one of the virus's recorded hosts. orfdata also provides RNA, ribosome and protein measurements for human, mouse, dog and yeast.

viral_references(host="human", group="HPV", virus_type="HPV16") finds source-qualified ViralReference objects. Choose a stable ID with viral_reference("NC_001526.4"), then use .dna and .orfs to load its packaged bases and coding paths. The functional loaders remain available. When annotating an existing alignment, viral_orfs(reference_dna, contig="HPV16") checks its actual reference sequence before applying the same models. The first coding reference contains the nine RefSeq NC_001526.4 HPV16 CDSs, with native and GDC placements; the host association is distinct from the virus's own taxon. Broader imports remain in the viral roadmap.

Measurement datasets

RNA, ribosome and protein measurements are separate, downloadable datasets with the same species-scoped API. Install the data extra, then download and query one:

pip install 'orfdata[data]'
orfdata datasets list
orfdata datasets download ingolia-yeast-rna-ribo
Guide Species Measurements
Protein abundance Human, mouse, dog TMT protein groups (Oziolor et al.)
RNA abundance Dog, mouse Native gene counts (Oziolor et al.)
Matched human tissues Human RNA and protein from adjacent cryosections (Wang et al.)
Yeast protein and RNA Budding yeast Calibrated protein and RNA abundance (CoPY)
Yeast RNA and ribosome occupancy Budding yeast Source regions, including UTR and ncRNA labels (Ingolia et al.)
Dog peptides Dog DLA class I ligands from tumours (Kaabinejadian et al.); Canine PeptideAtlas peptides and protein calls, built locally

Gene RNA and canonical protein measurements do not establish noncanonical ORF abundance. See released data and gaps.

Documentation

The documentation covers:

Task Guide
Build a proteome: evidence levels, exclusions, contigs, viral proteins Build a reference proteome
ORF classes, evidence definitions, Varcode and Isovar integration ORFs and evidence
Species and reference identity, mitochondrial genetic codes Species, references and genetic codes
Versioned ORF catalogues managed through DataCache Optional ORF catalogues
Quantitative datasets and what has been released Measurements, released data and gaps

The data roadmap tracks further species and sources. Every PR includes a version bump, lint and tests; maintainers publish with ./deploy.sh from clean 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.34.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for orfdata 0.34.1
File Size Uploaded Provenance Actions
orfdata-0.34.1.tar.gz 3.1 MB Without provenance Details for orfdata-0.34.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for orfdata 0.34.1
File Interpreter ABI Platform Actions
orfdata-0.34.1-py3-none-any.whl Python 3 none any Details for orfdata-0.34.1-py3-none-any.whl

Total release size: 5.2 MB

Release files / orfdata-0.34.1.tar.gz

Download URL orfdata-0.34.1.tar.gz
Size 3.1 MB
Tags Source
SHA-256 checksum
How to use checksums
22d19b3320103355572e8632451309d8238c7ce175d0765bb79d8ed77b17586b
BLAKE2b-256 checksum
How to use checksums
5aa31ee2ab320d4dcddbe465b9da528ecb8c4c6301d18d27699937bf2211b9a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.12

Release files / orfdata-0.34.1-py3-none-any.whl

Download URL orfdata-0.34.1-py3-none-any.whl
Size 2.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
400e535f618e3961182ba7c5e6db683fd4707c5a187ed5132fc8fb9c9df0d849
BLAKE2b-256 checksum
How to use checksums
c80b3aed13f448c8c18ff0599a2bf73205305b02ef5d359a8ff823aa0962373f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.12

Security for orfdata 0.34.1

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.

Release history Release notifications | RSS feed

This release

0.34.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page