annotate readme.rst @ 2:d03a63a57e82 draft

New version, better following configuration guidelines
author geert-vandeweyer
date Wed, 19 Feb 2014 06:45:32 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
1 Galaxy wrapper for VariantDB Import
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
2 ===================================
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
3
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
4 This wrapper and VariantDB is written by Geert Vandeweyer.
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
5
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
6 The recommended installation is by means of the toolshed_.
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
7
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
8 .. _toolshed: http://toolshed.g2.bx.psu.edu/view/geert-vandeweyer/vcf_to_variantdb
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
9
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
10 Galaxy should be able to install the needed perl module dependencies automatically
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
11 for you. To allow your server to communicate with VariantDB, you must edit the GALAXY_URL environment variable in the file:
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
12
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
13 <tool_dependency_dir>/environment_settings/GALAXY_URL/geert-vandeweyer/vcf_to_variantdb/<hash_string>/env.sh
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
14
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
15 to point to the full URL of the server (e.g: http://biominavm-galaxy.biomina.be/galaxy ) where you have installed the wrapper.
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
16
d03a63a57e82 New version, better following configuration guidelines
geert-vandeweyer
parents:
diff changeset
17 Finally, if you also have a private VariantDB instance, you need to add it to the wrapper configuration file, as an extra option.