Skip to main content

Tests Documentation PyPI

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.

Tab completion: run activate-global-python-argcomplete once, for every command that supports argcomplete, or put eval "$(register-python-argcomplete orfdata)" in your shell's startup file.

Documentation

The documentation covers, in reading order:

  1. Getting started: install, a first proteome, ncORF evidence presets and supported species.
  2. Build a reference proteome: evidence filters, excluded ORFs, viral and sample-derived proteins, FASTA headers.
  3. Discover and download data: the orfdata data workflow and the cache.
  4. Downstream tools: ncORFs and viral references in varcode, isovar, topiary and vaxrank.
  5. ORFs and evidence: ORF classes and what each kind of evidence supports.
  6. Measurements: the quantitative datasets and their query API.

Release notes are in CHANGELOG.md; the data roadmap tracks further species and sources.

Development

./develop.sh # 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.50.0

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.50.0
File Size Uploaded Provenance Actions
orfdata-0.50.0.tar.gz 3.9 MB Without provenance Details for orfdata-0.50.0.tar.gz

Built distribution (wheel)

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

Total release size: 6.2 MB

Release files / orfdata-0.50.0.tar.gz

Download URL orfdata-0.50.0.tar.gz
Size 3.9 MB
Tags Source
SHA-256 checksum
How to use checksums
03453e241cf2b8ad26d633fffce7b092ae0333fcfe570e3bff6e28ab57d91e62
BLAKE2b-256 checksum
How to use checksums
bf4a72a9a50091f55f822bea6571e2dbc7811e9107a1ca8835358bdc08b67300
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

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

Download URL orfdata-0.50.0-py3-none-any.whl
Size 2.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
bcc562a95b8bd09d4a0f518bc53437fc426b9d404c5c1a38ce2b5f4304d9d197
BLAKE2b-256 checksum
How to use checksums
8302a00d3853dc140e14378b679f7cdb0546315f4fc1a5b282d09b70171493cb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Security for orfdata 0.50.0

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.50.0 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