annotate readme.rst @ 4:f244b8209eb8 draft

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