Skip to main content

Predict splicing variant effect from VCF

Project description

mmsplice

CircleCI pypi

Predict splicing variant effect from VCF

Paper: Cheng et al. https://doi.org/10.1101/438986

MMSplice

Installation


External dependencies:

pip install cyvcf2 cython

Conda installation is recommended:

conda install cyvcf2 cython -y
pip install mmsplice

Run MMSplice Online

You can run mmsplice with following google colab notebooks online:

Preparation


1. Prepare annotation (gtf) file

Standard human gene annotation file in GTF format can be downloaded from ensembl or gencode. MMSplice can work directly with those files, however, some filtering is higly recommended.

  • Filter for protein coding genes.

2. Prepare variant (VCF) file

A correctly formatted VCF file with work with MMSplice, however the following steps will make it less prone to false positives:

  • Quality filtering. Low quality variants leads to unreliable predictions.
  • Avoid presenting multiple variants in one line by splitting them into multiple lines. Example code to do it:
    bcftools norm -m-both -o out.vcf in.vcf.gz
    
  • Left-normalization. For instance, GGCA-->GG is not left-normalized while GCA-->G is. Details for unified representation of genetic variants see Tan et al.
    bcftools norm -f reference.fasta -o out.vcf in.vcf
    

3. Prepare reference genome (fasta) file

Human reference fasta file can be downloaded from ensembl/gencode. Make sure the chromosome name matches with GTF annotation file you use.

Example code


Check notebooks/example.ipynb

To score variants (including indels), we suggest to use primarily the deltaLogitPSI predictions, which is the default output. The differential splicing efficiency (dse) model was trained from MMSplice modules and exonic variants from MaPSy, thus only the predictions for exonic variants are calibrated.

# Import
from mmsplice.vcf_dataloader import SplicingVCFDataloader
from mmsplice import MMSplice, predict_all_table
from mmsplice.utils import max_varEff

# example files
gtf = 'tests/data/test.gtf'
vcf = 'tests/data/test.vcf.gz'
fasta = 'tests/data/hg19.nochr.chr17.fa'
csv = 'pred.csv'

# dataloader to load variants from vcf
dl = SplicingVCFDataloader(gtf, fasta, vcf)

# Specify model
model = MMSplice()

# predict and save to csv file
predict_save(model, dl, csv, pathogenicity=True, splicing_efficiency=True)

# Or predict and return as df
predictions = predict_all_table(model, dl, pathogenicity=True, splicing_efficiency=True)

# Summerize with maximum effect size
predictionsMax = max_varEff(predictions)

Output

Output of MMSplice is an tabular data which contains following described columns:

  • ID: id string of the variant
  • delta_logit_psi: The main score is predicted by MMSplice, which shows the effect of the variant on the inclusion level (PSI percent spliced in) of the exon. The score is on a logit scale. If the score is positive, it shows that variant leads higher inclusion rate for the exon. If the score is negative, it shows that variant leads higher exclusion rate for the exon. If delta_logit_psi is bigger than 2 or smaller than -2, the effect of variant can be considered strong.
  • exons: Genetics location of exon whose inclusion rate is effected by variant
  • exon_id: Genetic id of exon whose inclusion rate is effected by variant
  • gene_id: Genetic id of the gene which the exon belongs to.
  • gene_name: Name of the gene which the exon belongs to.
  • transcript_id: Genetic id of the transcript which the exon belongs to.
  • ref_acceptorIntron: acceptor intron score of the reference sequence
  • ref_acceptor: acceptor score of the reference sequence
  • ref_exon: exon score of the reference sequence
  • ref_donor: donor score of the reference sequence
  • ref_donorIntron: donor intron score of the reference sequence
  • alt_acceptorIntron: acceptor intron score of variant sequence
  • alt_acceptor: acceptor score of the sequence with variant
  • alt_exon: exon score of the sequence with variant
  • alt_donor: donor score of the sequence with variant
  • alt_donorIntron: donor intron score of the sequence with variant
  • pathogenicity: Potential pathogenic effect of the variant.
  • efficiency: The effect of the variant on the splicing efficiency of the exon.

VEP Plugin

The VEP plugin wraps the prediction function from mmsplice python package. Please check documentation of vep plugin under VEP_plugin/README.md.

======= History

1.0.0 (2019-07-23)

  • Dependicies fixed #16
  • Valide gtf, fasta, vcf chrom annotation #15
  • Ship mmsplice with prebuild exon set. #12
  • Faster variant overlapping with pyranges #11
  • Batch prediction with masking update in exon module

0.1.0 (2018-07-17)

  • First release on PyPI.

Project details


Download files

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

Source Distribution

mmsplice-1.0.3.tar.gz (26.7 MB view details)

Uploaded Source

Built Distribution

mmsplice-1.0.3-py2.py3-none-any.whl (26.7 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file mmsplice-1.0.3.tar.gz.

File metadata

  • Download URL: mmsplice-1.0.3.tar.gz
  • Upload date:
  • Size: 26.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.1

File hashes

Hashes for mmsplice-1.0.3.tar.gz
Algorithm Hash digest
SHA256 44f94b6c4bd42045c759726aee59284c3adfb5f35e47f848fda85c5e01cceffa
MD5 6960c9700d2dcc5b42472302e2c1aad3
BLAKE2b-256 ddd670fa14453102c85a1c4f18d2dc97ba673e2efa9f074a81111553d00bfecc

See more details on using hashes here.

File details

Details for the file mmsplice-1.0.3-py2.py3-none-any.whl.

File metadata

  • Download URL: mmsplice-1.0.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 26.7 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.1

File hashes

Hashes for mmsplice-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 06a7ddef124aa04d5d960cf72f220b9ca2a4a9a499b3fce31f2e0408b2cf5504
MD5 057f7c0858d4273c21fd9cc972451768
BLAKE2b-256 4f6b92361db3649bf28e3cf6834ab7619e041b27c4fa8b8ef0031c15c3101f61

See more details on using hashes here.

Supported by

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