Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 3.82 KB

README.md

File metadata and controls

61 lines (35 loc) · 3.82 KB
Raw

Build Status License Uptime Robot status

GRASP

GRASP is a tool for performing ancestral sequence reconstruction.

GRASP is part of the GRASP-suite of tools for curating, performing, and analysing ancestral sequence reconstruction.

This is the repository for the web service / GUI version of GRASP.

What does GRASP do?

The GRASP web service was developed to facilitate the steps of performing a reconstruction of ancestor sequences (represented by partial-order graphs) and the exploration, archival and sharing of the output. The service consists of three major parts: an inference engine bnkit written in Java, a web service backend written in Java using the Spring framework and Postgres, and web client functionality written in Javascript. The latter two are contained in the open source project GRASP. GRASP depends on the open source project bnkit for performing phylogenetic inference.

How do you use GRASP?

The GRASP web service incorporates a user guide that we recommend when you start out. You will find it in the menu at the top of the GRASP screen at all times.

Use any standard web browser and enter the URL http://grasp.scmb.uq.edu.au. We recommend that you # for an account; with an account you will be able to use a lot of features that otherwise are unavailable.

What else?

There is a command-line version to run reconstructions on your local hardware. This version does not have all the features; for instance there is no interactive mode and currently no way of transferring your reconstruction to the web service.

Docker

GRASP is available through Docker Hub at gabefoley/grasp

Once you have docker installed you can

docker run -it -v {full path to where your data is located}:/data gabefoley/grasp grasp -aln /data/{name of your alignment file}.aln -nwk /data/{name of your newick file}.nwk -out /data

for example, for me the command looks like (I have test_6.aln and test_6.nwk sitting in a /data folder):

docker run -it -v /Users/coolusername/Documents/code/grasp/data:/data grasp-docker grasp -aln /data/test_6.aln -nwk /data/test_6.nwk -out /data

This should give you a file, GRASP_ancestors.fasta appearing in folder: /Users/coolusername/Documents/code/grasp/data.

Resources

A paper that describes GRASP and its evaluation in detail is available as a pre-print from bioRxiv.

bnkit - the code for performing inference within GRASP

GRASP-suite - information about ancestral sequence reconstruction and a link to download the command line version of GRASP

GRASP-resources - Supplementary material for the GRASP paper and Jupyter Notebooks for performing sequence curation

Tutorials and material to support GRASP are available at GRASP-resources

Development

Get in contact with the Boden lab; see http://bioinf.scmb.uq.edu.au or http://grasp.scmb.uq.edu.au.