This is a prototype for the GA4GH reference client and server applications. It is under heavy development, and many aspects of the layout and APIs will change as requirements are better understood. If you would like to help, please check out our list of issues!
Our aims for this implementation are:
- Simplicity/clarity
- The main goal of this implementation is to provide an easy to understand and maintain implementation of the GA4GH API. Design choices are driven by the goal of making the code as easy to understand as possible, with performance being of secondary importance. With that being said, it should be possible to provide a functional implementation that is useful in many cases where the extremes of scale are not important.
- Portability
- The code is written in Python for maximum portability, and it should be possible to run on any modern computer/operating system (Windows compatibility should be possible, although this has not been tested). We use a subset of Python 3 which is backwards compatible with Python 2 following the current best practices. In this way, we fully support both Python 2 and 3.
- Ease of use
- The code follows the Python Packaging User Guide. This will
make installing the
ga4ghreference code very easy across a range of operating systems.
Two implementations of the variants API are available that can serve data based on existing VCF files. These backends are based on tabix and wormtable, which is a Python library to handle large scale tabular data. See Wormtable backend for instructions on serving VCF data from the GA4GH API.
The wormtable backend allows us to serve variants from an arbitrary VCF file.
The VCF file must first be converted to wormtable format using the vcf2wt
utility (the wormtable tutorial discusses this process).
A subset (1000 rows for each chromosome) of the 1000 Genomes VCF data (20110521
and 20130502 releases) has been prepared and converted to wormtable format
and made available here.
See Converting 1000G data for more information on converting 1000 genomes
data into wormtable format.
To run the server on this example dataset, create a virtualenv and install wormtable:
$ virtualenv testenv $ source testenv/bin/activate $ pip install wormtable
See the wormtable PyPI page for detailed instructions on installing wormtable and its dependencies.
Now, download and unpack the example data,
$ wget http://www.well.ox.ac.uk/~jk/ga4gh-example-data.tar.gz $ tar -zxvf ga4gh-example-data.tar.gz
and install the client and server scripts into the virtualenv (assuming you are in the project root directory):
$ python setup.py install
We can now run the server, telling it to serve variants from the sets in the downloaded datafile:
$ ga4gh_server wormtable ga4gh-example-data
To run queries against this server, we can use the ga4gh_client program;
for example, here we run the variants/search method over the
1000g_2013 variant set, where the reference name is 1, the end coordinate
is 60000 and we only want calls returned for call set ID HG03279:
$ ga4gh_client variants-search http://localhost:8000 1000g_2013 -r1 -e 60000 -c HG03279 | less -S
We can also query against the variant name; here we return the variant that
has variant name rs75454623:
$ ga4gh_client variants-search http://localhost:8000 1000g_2013 -r1 -e 60000 -n rs75454623 | less -S
To duplicate the data for the above example, we must first create VCF files
that contain the entire variant set of interest. The VCF files for the set
mentioned above have been made available. After downloading
and extracting these files, we can build the wormtable using vcf2wt:
$ vcf2wt 1000g_2013-subset.vcf -s schema-1000g_2013.xml -t 1000g_2013
Schemas for the 2011 and 2013 1000G files have been provided as these do a
more compact job of storing the data than the default auto-generated schemas.
We must also truncate and remove some columns because of a current limitation
in the length of strings that wormtable can handle.
After building the table, we must create indexes on the POS and ID columns:
$ wtadmin add 1000g_2013 CHROM+POS $ wtadmin add 1000g_2013 CHROM+ID
The wtadmin program supports several
commands to administer and examine the dataset; see wtadmin help for details.
These commands and schemas also work for the full 1000G data; however, it is
important to specify a sufficiently large cache size when
building and indexing such large tables.
The tabix backend allows us to serve variants from an arbitrary VCF file. The VCF file must first be indexed with tabix. Many projects, including the 1000 genomes project, release files with tabix indices already precomputed. This backend can serve such datasets without any preprocessing via the command:
$ ga4gh_server tabix DATADIR
where DATADIR is a directory that contains subdirectories of tabix-indexed VCF file(s). There cannot be more than one VCF file in any subdirectory that has data for the same reference contig.
The code for the project is held in the ga4gh package, which corresponds to
the ga4gh directory in the project root. Within this package, the
functionality is split between the client, server, protocol and
cli modules. The cli module contains the definitions for the
ga4gh_client and ga4gh_server programs.
For development purposes, it is useful to be able to run the command line
programs directly without installing them. To do this, use the
server_dev.py and client_dev.py scripts. (These are just shims to
facilitate development, and are not intended to be distributed. The
distributed versions of the programs are packaged using the setuptools
entry_point key word; see setup.py for details). For example, the run
the server command simply run:
$ python server_dev.py
usage: server_dev.py [-h] [--port PORT] [--verbose] {help,wormtable,tabix} ...
server_dev.py: error: too few arguments
The code follows the guidelines of PEP 8 in most cases. The only notable difference is the use of camel case over underscore delimited identifiers; this is done for consistency with the GA4GH API. Code should be checked for compliance using the pep8 tool.
TODO Give simple instructions for deploying the server on common platforms like Apache and Nginx.
Configuration parameters are specified in the file ga4gh/server/config.py; they can be overridden by setting the absolute path of a file containing new values in the environment variable GA4GH_CONFIGURATION.
The tests/ directory contains tests for the backend objects and the autogenerated schemas. To run these tests use the following commands from the projects's root directory:
Set up a virtualenv and install nose:
$ virtualenv testenv $ source testenv/bin/activate $ pip install nose
then install the client and server scripts into the virtualenv:
$ python setup.py install
and run the tests:
$ nosetests