annotate readme.rst @ 6:b80301676614 draft

Uploaded
author iuc
date Wed, 18 Feb 2015 11:36:59 -0500
parents e67da4f2c9bf
children 86007c982f00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
1 Galaxy wrapper for GATK2
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
2 ========================
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
3
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
4 This wrapper is copyright 2013 by Björn Grüning, Jim Johnson & the Galaxy Team.
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
5
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
6 The Genome Analysis Toolkit or GATK is a software package developed at the
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
7 Broad Institute to analyse next-generation resequencing data. The toolkit offers
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
8 a wide variety of tools, with a primary focus on variant discovery and
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
9 genotyping as well as strong emphasis on data quality assurance. Its robust
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
10 architecture, powerful processing engine and high-performance computing features
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
11 make it capable of taking on projects of any size.
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
12
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
13 http://www.broadinstitute.org/gatk
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
14 http://www.broadinstitute.org/gatk/about/citing-gatk
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
15
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
16 GATK is Free for academics, and fee for commercial use. Please study the GATK licensing website:
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
17 http://www.broadinstitute.org/gatk/about/#licensing
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
18
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
19
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
20 Installation
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
21 ============
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
22
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
23 The recommended installation is by means of the toolshed_.
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
24
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
25 .. _toolshed: http://toolshed.g2.bx.psu.edu/view/iuc/gatk2
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
26
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
27 Galaxy should be able to install samtools dependencies automatically
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
28 for you. GATK2, and its new licence model, does not allow us to distribute the GATK binaries.
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
29 As a consequence you need to install GATK2 by your own, please see the GATK website for more information:
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
30
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
31 http://www.broadinstitute.org/gatk/download
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
32
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
33 Once you have installed GATK2, you need to edit the env.sh files that are installed together with the wrappers.
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
34 You must edit the GATK2_PATH environment variable in the file:
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
35
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
36 <tool_dependency_dir>/environment_settings/GATK2_PATH/iuc/gatk2/<hash_string>/env.sh
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
37
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
38 to point to the folder where you have installed GATK2.
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
39
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
40 Optionally, you may also want to edit the GATK2_SITE_OPTIONS environment variable in the file:
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
41
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
42 <tool_dependency_dir>/environment_settings/GATK2_SITE_OPTIONS/iuc/gatk2/<hash_string>/env.sh
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
43
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
44 to deactivate the 'call home feature' of GATK with something like:
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
45
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
46 GATK2_SITE_OPTIONS='-et NO_ET -K /data/gatk2_key_file'
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
47
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
48 GATK2_SITE_OPTIONS can be also used to insert other specific options into every GATK2 wrapper
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
49 at runtime, without changing the actual wrapper.
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
50
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
51 Read more about the "Phone Home" problem at:
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
52 http://www.broadinstitute.org/gatk/guide/article?id=1250
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
53
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
54 Optionally, you may also want to add some commands to be executed before GATK (e.g. to load modules) to the file:
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
55
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
56 <tool_dependency_dir>/gatk2/default/env.sh
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
57
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
58 Finally, you should fill in additional information about your genomes and
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
59 annotations in the gatk2_picard_index.loc and gatk2_annotations.txt.
4
e67da4f2c9bf Uploaded
bgruening
parents: 0
diff changeset
60 You can find them in the tool-data/ Galaxy directory.
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
61
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
62
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
63 History
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
64 =======
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
65
6
b80301676614 Uploaded
iuc
parents: 4
diff changeset
66 * v0.1 - Initial public release
b80301676614 Uploaded
iuc
parents: 4
diff changeset
67 * v2.8.0 - Bugfix release, increase version number to reflect the underlying GATK version
0
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
68
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
69
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
70 Licence (MIT)
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
71 =============
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
72
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
73 Permission is hereby granted, free of charge, to any person obtaining a copy
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
74 of this software and associated documentation files (the "Software"), to deal
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
75 in the Software without restriction, including without limitation the rights
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
76 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
77 copies of the Software, and to permit persons to whom the Software is
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
78 furnished to do so, subject to the following conditions:
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
79
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
80 The above copyright notice and this permission notice shall be included in
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
81 all copies or substantial portions of the Software.
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
82
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
83 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
84 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
85 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
86 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
87 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
88 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
9ad15075b9fa Uploaded
iuc
parents:
diff changeset
89 THE SOFTWARE.