Skip to main content

Transcripts for HGVS libraries

Project description

cdot

PyPi version Python versions

cdot provides transcripts for the 2 most popular Python HGVS libraries.

It works by:

  • Converting RefSeq/Ensembl GTFs to JSON
  • Providing loaders for the HGVS libraries, via JSON.gz files, or REST API via cdot_rest)

We currently support ~800k transcripts (vs ~141k in UTA v.20210129)

Install

pip install cdot

Examples

Biocommons HGVS example:

from cdot.hgvs.dataproviders import JSONDataProvider, RESTDataProvider

hdp = RESTDataProvider()  # Uses API server at cdot.cc
# hdp = JSONDataProvider(["./cdot-0.2.1.refseq.grch38.json.gz"])  # Uses local JSON file

am = AssemblyMapper(hdp,
                    assembly_name='GRCh37',
                    alt_aln_method='splign', replace_reference=True)

hp = hgvs.parser.Parser()
var_c = hp.parse_hgvs_variant('NM_001637.3:c.1582G>A')
am.c_to_g(var_c)

PyHGVS example:

from cdot.pyhgvs.pyhgvs_transcript import JSONPyHGVSTranscriptFactory, RESTPyHGVSTranscriptFactory

factory = RESTPyHGVSTranscriptFactory()
# factory = JSONPyHGVSTranscriptFactory(["./cdot-0.2.1.refseq.grch38.json.gz"])  # Uses local JSON file
pyhgvs.parse_hgvs_name(hgvs_c, genome, get_transcript=factory.get_transcript_grch37)

Q. What's the performance like?

  • UTA public DB: 1-1.5 seconds / transcript
  • cdot REST service: 10/second
  • cdot JSON.gz: 500-1k/second

Q. Where can I download the JSON.gz files?

RefSeq 37+38 - 70Mb Ensembl 37+38 - 53Mb

See also Download JSON.gz files if you only want individual builds.

Q. How does this compare to Universal Transcript Archive?

Both projects have similar goals of providing transcripts for loading HGVS, but they approach it from different ways

  • UTA aligns sequences, then stores coordinates in an SQL database.
  • cdot convert existing Ensembl/RefSeq GTFs into JSON

See wiki for more details

Q. How do you store transcripts in JSON?

See wiki page for the format.

We think a standard for JSON gene/transcript information would be a great thing, and am keen to collaborate to make it happen!

Q. What does cdot stand for?

cdot, pronounced "see dot" stands for Complete Dict of Transcripts

This was developed for the Australian Genomics Shariant project, due to the need to load historical HGVS from lab archives.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cdot-0.2.4-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file cdot-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: cdot-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.8.0 tqdm/4.62.2 CPython/3.8.10

File hashes

Hashes for cdot-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2a03c45c54136f22f2ee632744fa49e09605188f44f9c805d43d1e8d2fbbb692
MD5 ff2d9104d8c8174d7198693f6b8ddbc5
BLAKE2b-256 ff070fb447f1d69692e87d6479eae39f3566e7118dd09849de9c67c349bf65c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page