Skip to main content

BGVEP

Read data generated within the bgvep project. Within that project there are two datasets, both identified by the reference genome (e.g. hg19) and the VEP version (e.g. 88):

  • a tabix file with the run of vep for all positions in the genome

  • a bgpack file with only the most severe consequence type.

Installation

This project is a Python package and can be installed with pip. Download the source code, get into this project directory and execute:

pip install .

Usage

To request the output of 1 or more positions, simply indicate the chromosome, the initial and the final positions you are interested.

Commad line usage

Execute bgvep --help for getting all the information.

The output is printed to the screen using tabs as separators for the indexes:

bgvep --genome hg19 --vep 88 --chromosome chr1 --begin 100000 --end 100004

Adding the --most-severe flags, returns the most severe consequence type for the 3 possible changes of the allele in that position.

Python usage

The easiest way to use bgvep is to make use of the generators get and get_most_severe.

from bgvep import get
for data in get('hg19', '88', 'chr1', 100000, 100004):
    ...

However, the best way to use bgvep is using directly the readers: the Tabix and the BGPack readers, which are context managers.

from bgvep.readers import Tabix

with Tabix('hg19', '88') as reader:
     for data in reader.get('chr1', 100000, 100004):
          ...

The advantage of using directly the readers is that they are not instantiated on every call.

The output

The format of the output is:

  • Chromosome

  • Position

  • Reference

  • Alternate

  • Gene

  • Feature

  • Feature_type

  • Consequence

  • cDNA_position

  • CDS_position

  • Protein_position

  • Amino_acids

  • Codons

  • Existing_variation

  • Impact

  • Distance

  • Strand

  • Flags

  • Symbol

  • Symbol source

  • HGNC_ID

  • Canonical

  • ENSP

When asking for the most-severe consquence type, the output is formed by the most severe consequente type of all the possible changes of the reference allele. The order is always ACGT, and if the refernce allele changes to itself, nothing is returned for it.

Support

If you are having issues, please let us know. You can contact us at: bbglab@irbbarcelona.org

Metadata

Release files for bgvep 0.3

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

Source distribution (sdist)

Source distribution for bgvep 0.3
File Size Uploaded Provenance Actions
bgvep-0.3.tar.gz 4.0 kB Without provenance Details for bgvep-0.3.tar.gz

Release files / bgvep-0.3.tar.gz

Download URL bgvep-0.3.tar.gz
Size 4.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1bdec43c3d0fabc77ef1f2f5f69240e4f15ab1b9887d901666b682b440543b28
BLAKE2b-256 checksum
How to use checksums
683cb3176bac10d6bfbbabaf4d7a747fe04dd7d7647c8bbb48010747eaf7fa06
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

Security for bgvep 0.3

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.3 This release

1 release file 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