annotate cgatools/README.txt @ 0:3b8b80827fbe draft default tip

Uploaded
author greg
date Fri, 22 Jun 2012 14:25:22 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3b8b80827fbe Uploaded
greg
parents:
diff changeset
1 Provides galaxy tools for Complete Genomics' cgatools package - http://www.completegenomics.com
3b8b80827fbe Uploaded
greg
parents:
diff changeset
2
3b8b80827fbe Uploaded
greg
parents:
diff changeset
3 This repository provides tools to execute functions of cgatools from Complete Genomics, Inc.
3b8b80827fbe Uploaded
greg
parents:
diff changeset
4 and includes the cgatools 1.5 executable.
3b8b80827fbe Uploaded
greg
parents:
diff changeset
5
3b8b80827fbe Uploaded
greg
parents:
diff changeset
6 Reference genomes files for cgatools can be downloaded from Complete Genomics ftp site:
3b8b80827fbe Uploaded
greg
parents:
diff changeset
7 ftp://ftp.completegenomics.com/ReferenceFiles/build37.crr
3b8b80827fbe Uploaded
greg
parents:
diff changeset
8 ftp://ftp.completegenomics.com/ReferenceFiles/build36.crr
3b8b80827fbe Uploaded
greg
parents:
diff changeset
9 After copying the files in the desired locations follow the instructions below to register
3b8b80827fbe Uploaded
greg
parents:
diff changeset
10 the reference files with galaxy.
3b8b80827fbe Uploaded
greg
parents:
diff changeset
11
3b8b80827fbe Uploaded
greg
parents:
diff changeset
12
3b8b80827fbe Uploaded
greg
parents:
diff changeset
13
3b8b80827fbe Uploaded
greg
parents:
diff changeset
14
3b8b80827fbe Uploaded
greg
parents:
diff changeset
15 AUTOMATIC INSTALL
3b8b80827fbe Uploaded
greg
parents:
diff changeset
16
3b8b80827fbe Uploaded
greg
parents:
diff changeset
17 When prompted for a tool panel section to contain the installed tools create a new section
3b8b80827fbe Uploaded
greg
parents:
diff changeset
18 called 'Complete Genomics - cgatools 1.5'.
3b8b80827fbe Uploaded
greg
parents:
diff changeset
19
3b8b80827fbe Uploaded
greg
parents:
diff changeset
20 After install create a cg_ccr_files.loc file in the tool-data directory of your Galaxy
3b8b80827fbe Uploaded
greg
parents:
diff changeset
21 instance by copying the cg_ccr_files.loc.sample file. In cg_ccr_files.loc edit the path
3b8b80827fbe Uploaded
greg
parents:
diff changeset
22 for the reference genome files (.crr files) downloaded from Complete Genomics' ftp site.
3b8b80827fbe Uploaded
greg
parents:
diff changeset
23
3b8b80827fbe Uploaded
greg
parents:
diff changeset
24 Restart Galaxy instance after editing cg_crr_files.loc.
3b8b80827fbe Uploaded
greg
parents:
diff changeset
25
3b8b80827fbe Uploaded
greg
parents:
diff changeset
26
3b8b80827fbe Uploaded
greg
parents:
diff changeset
27
3b8b80827fbe Uploaded
greg
parents:
diff changeset
28
3b8b80827fbe Uploaded
greg
parents:
diff changeset
29 MANUAL INSTALL
3b8b80827fbe Uploaded
greg
parents:
diff changeset
30
3b8b80827fbe Uploaded
greg
parents:
diff changeset
31 For manual install from compressed files move/copy the following files into your Galaxy instance:
3b8b80827fbe Uploaded
greg
parents:
diff changeset
32 directory tools/cgatools_v1.5 to tools/
3b8b80827fbe Uploaded
greg
parents:
diff changeset
33 file lib/galaxy/datatypes/completegenomics.py to lib/galaxy/datatypes/
3b8b80827fbe Uploaded
greg
parents:
diff changeset
34 file tool-data/cg_crr_files.loc.sample to tool-data/cg_crr_files.loc
3b8b80827fbe Uploaded
greg
parents:
diff changeset
35
3b8b80827fbe Uploaded
greg
parents:
diff changeset
36 In cg_ccr_files.loc edit the path for the reference genome files (.crr files) downloaded
3b8b80827fbe Uploaded
greg
parents:
diff changeset
37 from Complete Genomics' ftp site.
3b8b80827fbe Uploaded
greg
parents:
diff changeset
38
3b8b80827fbe Uploaded
greg
parents:
diff changeset
39 Paste from tool_config.xml.sample into the tool_config.xml of your Galaxy instance:
3b8b80827fbe Uploaded
greg
parents:
diff changeset
40 <!--
3b8b80827fbe Uploaded
greg
parents:
diff changeset
41 Copy the following section to tool_conf.xml file in your Galaxy distribution if you are adding Complete Genomics tools manually to your Galaxy instance
3b8b80827fbe Uploaded
greg
parents:
diff changeset
42 -->
3b8b80827fbe Uploaded
greg
parents:
diff changeset
43 <section name="Complete Genomics - cgatools v1.5" id="cg_cgatools1.5">
3b8b80827fbe Uploaded
greg
parents:
diff changeset
44 <tool file="cgatools_v1.5/listvariants.xml" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
45 <tool file="cgatools_v1.5/testvariants.xml" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
46 <tool file="cgatools_v1.5/listtestvariants.xml" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
47 <tool file="cgatools_v1.5/calldiff.xml" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
48 <tool file="cgatools_v1.5/snpdiff.xml" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
49 <tool file="cgatools_v1.5/junctiondiff.xml" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
50 <tool file="cgatools_v1.5/join.xml" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
51 <tool file="cgatools_v1.5/varfilter.xml" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
52 </section>
3b8b80827fbe Uploaded
greg
parents:
diff changeset
53 <!-- End of copied section -->
3b8b80827fbe Uploaded
greg
parents:
diff changeset
54
3b8b80827fbe Uploaded
greg
parents:
diff changeset
55 Paste from tool_data_table_config.xml.sample into the tool_data_table_config.xml of your Galaxy instance:
3b8b80827fbe Uploaded
greg
parents:
diff changeset
56 <!-- Start location of cgatools crr files -->
3b8b80827fbe Uploaded
greg
parents:
diff changeset
57 <table name="cg_crr_files" comment_char="#">
3b8b80827fbe Uploaded
greg
parents:
diff changeset
58 <columns>value, dbkey, name, path</columns>
3b8b80827fbe Uploaded
greg
parents:
diff changeset
59 <file path="tool-data/cg_crr_files.loc" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
60 </table>
3b8b80827fbe Uploaded
greg
parents:
diff changeset
61 <!-- End Location of cgatools crr files -->
3b8b80827fbe Uploaded
greg
parents:
diff changeset
62
3b8b80827fbe Uploaded
greg
parents:
diff changeset
63 Paste from datatypes_conf.xml into the datatypes_conf.xml of your Galaxy instance:
3b8b80827fbe Uploaded
greg
parents:
diff changeset
64 <!--
3b8b80827fbe Uploaded
greg
parents:
diff changeset
65 Copy the following section to datatypes_conf.xml file in your Galaxy distribution if you are adding Complete Genomics tools manually to your Galaxy instance
3b8b80827fbe Uploaded
greg
parents:
diff changeset
66 -->
3b8b80827fbe Uploaded
greg
parents:
diff changeset
67 <!-- Start Complete Genomics Datatypes -->
3b8b80827fbe Uploaded
greg
parents:
diff changeset
68 <datatype extension="cg_var" type="galaxy.datatypes.completegenomics:CG_Var" display_in_upload="true" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
69 <datatype extension="cg_mastervar" type="galaxy.datatypes.completegenomics:CG_MasterVar" display_in_upload="true" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
70 <datatype extension="cg_gene" type="galaxy.datatypes.completegenomics:CG_Gene" display_in_upload="true" />
3b8b80827fbe Uploaded
greg
parents:
diff changeset
71 <!-- End Complete Genomics Datatypes -->
3b8b80827fbe Uploaded
greg
parents:
diff changeset
72 <!-- End of copied section -->
3b8b80827fbe Uploaded
greg
parents:
diff changeset
73
3b8b80827fbe Uploaded
greg
parents:
diff changeset
74 Restart Galaxy instance.