jessada / hbvdb_tools Goto Github PK

PREREQUISITE

- Vcftools (http://sourceforge.net/projects/vcftools/)

INSTALLATION

To install this module, run the following commands:

	sudo ./install.sh

SAMPLE USAGE

The sample command to add new variant frequency from the input in vcf format into the database

	./bin/bvd-add.pl -d example/sample_DB example/sample_input.vcf

The sample command to retrieve the variant frequency

	./bin/bvd-get.pl -d example/sample_DB

Please note that the database that was used in the above commands, 'example/sample_DB', is for tutorial purpose only.
Practically, you can insert variant frequencies into the database by only

	./bin/bvd-add.pl your_input.vcf

and can retrieve the variant frequency by only

	./bin/bvd-get.pl

SUPPORT AND DOCUMENTATION

After installing, you can find more information about this these tools in 

	hbvdb-tools.pdf

and you can find the library documentation at for this module by using perldoc command.

	perldoc Bvdb

LICENSE AND COPYRIGHT

Copyright (C) 2012 Jessada Thutkawkorapin

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.