Skip to content

AshleyLab/vesper

Repository files navigation

Image

Overview

VESPER is a variant interpretation pipeline that profiles each read of input SAM files to identify single nucleotide polymorphisms (SNPs) using the alignment's CS tag. It classifies detected variants on a per-read basis as single-nucleotide variants (SNVs), multi-nucleotide variants (MNVs), or a combination of both. These variants are then reformatted to follow HGVS nomenclature before utilising Ensembl's Variant Effect Predictor (VEP) to assess the functional consequences and potential pathogenicity of each variant, with particular emphasis on their implications in Dilated Cardiomyopathy. VESPER also includes downstream analyses to compare variant frequencies across different cell populations, elucidating population-specific variant distributions. High level architecture of the workflow is as shown in the schematic below.

Vesper's Workflow

Image

Pre-Requisites

  • Python 3.9
    • Ensure that Python 3.9 is installed on your system. Install it otherwise before proceeding.
  • Singularity image of Ensembl VEP
    • Refer to link for installation instructions

Installation of Vesper

  1. Navigate into directory where vesper is to be installed in
    wget https://github.com/AshleyLab/vesper/archive/refs/tags/vesper_v1.0.tar.gz
    tar -xvzf vesper.tar.gz
    

Set Up Vespers's Environment

  1. Navigate into vesper directory
    cd vesper
    
  2. Create and activate vesper_env
    python3.9 -m venv vesper_env         # create new python virtual env
    source vesper_env/bin/activate       # activate vesper_env
    
  3. Install packages
    python3 setup_vesper_env.py 
    

Configure vesper_config.yaml file

  1. Edit minigene_config.yaml file to suit your data

    Option 1: use vim directly in terminal to edit

    vim vesper_config.yaml
    
    # press 'i' to edit and make changes; when done, press 'esc', ':wq' and hit 'enter' to save and exit
    

    Option 2: edit locally on your preferred text editor

Execution

python3 vesper.py -c vesper_config.yaml

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published