/

SIFT Web Service Documentation

SIFT Nonsynonymous Single Nucleotide Variants Tool

Change Log

  • Updates 2 February 2012 Important bug fix!
    • Some users reported receiving incorrect result files. This bug has been fixed by incorporating a unique filename.
    • All older script will still work but you may risk getting an erroneous result (although the chance is slim). We suggest all users to update their script
    • Added announcement feature for script version and we can now notify user to download the latest release a job is completed
    • New scripts can be downloaded directly HERE
  • Updates 31 December 2012
    • Minor bug fixes: SIFT command line to work with SIFT version 5.0.2, SIFT database release June 06, 2012
    • Happy holidays to all!!
  • Updates 11 Oct 2012
    • Added error checking of intermediate file.
    • Added process feedback for user to track which step they are at.
    • Fix bug which user may encounter a long wait time before getting a timeout. This was usually due to errors in the config file.
    • Added checking of jobs in SIFT queue and dynamic wait time before job gets processed.

Motivation

The current SIFT web server is hosted here where it is publicly accessible to any user. Due to the hassle of installation, massive database download that comes with SIFT standalone, we have developed a web service for the benefit of SIFT users. SIFT Web Service is built on Amazon cloud with the capability of scaling up to cater to large number of SIFT jobs. With this, SIFT users can now sumbit batch jobs from command line less the installation of SIFT standalone. At the end of this guide, SIFT users will be able to run SIFT smoothly through the Web Serivce


Running SIFT Web Service

    1. Download SIFTexome_nssnvs.sh.tar.gz containing the script and config files

    2. Place it in your Unix/Linux working directory. You may use WINscp to do this. Alternatively, do a wget in your working directory.

    wget http://sift.bii.a-star.edu.sg/downloads/SIFTexome_nssnvs.sh.tar.gz

    3. Extract the files by doing:

    tar zxvf SIFTexome_nssnvs.sh.tar.gz

    This will extract the compressed file into the current directory. You should see two files: SIFTexome_nssnvs.sh and SIFTexome_nssnvs.conf.

    4. SIFTexome_nssnvs.sh is the main program used to submit a job to the web service. It takes in one parameter file SIFTexome_nssnvs.conf. You are only required to edit SIFTexome_nssnvs.conf!

    5. Let us move on to editing SIFTexome_nssnvs.conf.

    Open up SIFTexome_nssnvs.conf with your favourite editor software eg, vi or emacs.

    This is what you will see when you open up the file :

    error

    As we can see from above, comment lines begin with a '#' key. These will not be processed. You do not need to touch them!


    Editing SIFTexome_nssnvs.conf

    The first entry: ORGANISM can take value: ORGANISM='hg19'or ORGANISM='hg18'; depending on the human database you intend to run SIFT on.

    FILE1 is the path to your input file. For example, if your SIFt input file is in your home directory, then set it to FILE1='/home/username/siftformatfile'.Download a sift test file.

    EMAIL will contain your email address.

    FINALOUTDIR='/path_to_output_directory/output' . Change the path to the directory you want to retrieve the output to.

    Following that, you will see a long list of options.

    error

    These are closely familar to the check boxes you see in SIFT website; which they are.

    error

    Here instead of checking the checkboxes, set the options to value of '1' if you want to display additional results. If i want to display multiple rows for multiple-transcripts i will set: MULTI_TRANSCRIPTS=1. Leave the values at the default '0' to run SIFT with default settings.

    The last line of SIFTexome_nssnvs.conf contains the URL of our Web Service. Do not change this


    7. Save the changes you have made to SIFTexome_nssnvs.conf and exit the editor. We are now ready to submit our job to the Cloud server!

    8. Navigate to the directory containing SIFTexome_nssnvs.sh. We are going to send the job request by doing:

    ./SIFTexome_nssnvs.sh ./SIFTexome_nssnvs.conf


    9. The job has been submitted to our job queue and will be automatically processed and retrieved upon completion.

    10. Depending on the size of your file, the job nature and the number of SIFT users using the Web Service, the time for job completion may differ.

    You will see a string of processing text similar to below:

    error

    A message will be printed to screen informing you of the JobID. We recommend that you copy it down. Upon completion you will see "Job Completed". The script will exit with exit status 0. Move on to check out your output in your output directory!

    Hopefully by this point in time you have successfully ran your first SIFT Web Service tool!


Input

Supported formats

Supported format: SIFT format. Variants file (e.g Pileup, VCF4, Maq, SOAP, GFF3, CASAVA, cg) can be easily converted to SIFT format using this.

For more example of SIFT format please refer to SIFT format; Max file size < 5MB.

Files with size larger than 5MB will result in the following when submitting job:

error

Downloads

SIFT nonsynonymous single nucleotide variants tool

Test data

We also provide a sample data files for SIFT users to test run. This file is derived from 1000 Genomes and then converted to SIFT format. Download away and start running!.


Reference

SIFT website

Terms of Use

User will assume all risks for using SIFT Web Service, including but not limited to, unsupported or unreplicated research or medical data and information.

User will use the information and software provided at their own risk.