annotate cgatools/README.txt @ 22:c877b14b262c draft

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