Predict splicing variant effect from VCF
Project description
MMSplice & MTSplice
Predict (tissue-specific) splicing variant effect from VCF. MTSplice is integrated into MMSplice with the same API.
Paper: Cheng et al. https://doi.org/10.1101/438986, https://www.biorxiv.org/content/10.1101/2020.06.07.138453v1
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.
MTSplice To predict tissue-specific variant effect with MTSplice, specify tissue_specific=True
in SplicingVCFDataloader
.
# Import
from mmsplice.vcf_dataloader import SplicingVCFDataloader
from mmsplice import MMSplice, predict_save, 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, tissue_specific=False)
To predict tissue-specific effect, in the dataloader use tissue_specific=True
in the dataloader instead
dl = SplicingVCFDataloader(gtf, fasta, vcf, tissue_specific=True)
Run prediction with default MMSplice parameters
# Specify model
model = MMSplice()
# Or predict and return as df
predictions = predict_all_table(model, dl, pathogenicity=True, splicing_efficiency=True)
To predict variant effect on scale instead of . This option only works with tissue specific predictions dl = SplicingVCFDataloader(..., tissue_specific=True)
:
# Or predict and return as df
predictions = predict_all_table(model, dl, natural_scale=True)
One variant might map to multiple exons. In the end we summarize the effect of as the maximum across all exons.
# 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 variantdelta_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 variantexon_id
: Genetic id of exon whose inclusion rate is effected by variantgene_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 sequenceref_acceptor
: acceptor score of the reference sequenceref_exon
: exon score of the reference sequenceref_donor
: donor score of the reference sequenceref_donorIntron
: donor intron score of the reference sequencealt_acceptorIntron
: acceptor intron score of variant sequencealt_acceptor
: acceptor score of the sequence with variantalt_exon
: exon score of the sequence with variantalt_donor
: donor score of the sequence with variantalt_donorIntron
: donor intron score of the sequence with variantpathogenicity
: 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mmsplice-2.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d70a3a281b9433b89e6a8612cc2ca2611f54c35b90f46e16772b2868ec94b60a |
|
MD5 | d2d23cbe10c30a54d8ed2446a9b1042e |
|
BLAKE2b-256 | 14aa2bd61394b483d56b0d9011921e785d019848216336581b3144a21faff124 |