annotate testing_cgatools-982e19c29ec0/cgatools/tools/cgatools_1.6/junctiondiff.xml @ 0:ef23f9cd599b draft default tip

Uploaded
author devteam
date Thu, 27 Sep 2012 13:37:59 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
1 <tool id="cg_junctiondiff" name="junctiondiff(beta) 1.6" version="1.0.1">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
2 <!--
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
3 This tool creates a GUI for the junctiondiff function of cgatools from Complete Genomics, Inc.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
4 written 6-18-2012 by bcrain@completegenomics.com
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
5 updated 8-14-2012 by bcrain@completegenomics.com
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
6 -->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
7
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
8 <description>reports difference between junction calls</description>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
9
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
10 <command>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
11 <!-- print version of cgatools to STDOUT-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
12 cgatools | head -1;
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
13
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
14 <!-- print command lines to STDOUT-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
15 echo "cgatools junctiondiff --beta
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
16 --reference $crr.fields.path
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
17 --junctionsA $data_sources.inputA
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
18 --junctionsB $data_sources.inputB
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
19 --scoreThresholdA $scoreA
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
20 --scoreThresholdB $scoreB
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
21 --distance $distance
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
22 --minlength $minlength
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
23 --output-prefix cg_
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
24 $stat
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
25 ";
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
26
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
27 <!-- execute cgatools-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
28 cgatools junctiondiff --beta
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
29 --reference $crr.fields.path
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
30 --junctionsA $data_sources.inputA
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
31 --junctionsB $data_sources.inputB
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
32 --scoreThresholdA $scoreA
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
33 --scoreThresholdB $scoreB
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
34 --distance $distance
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
35 --minlength $minlength
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
36 --output-prefix cg_
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
37 $stat
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
38 ;
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
39 mv cg_diff-*tsv cg_diff.tsv
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
40 </command>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
41
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
42 <outputs>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
43 <data format="tabular" name="output1" from_work_dir="cg_diff.tsv" label="${tool.name} diff"/>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
44 <data format="tabular" name="output2" from_work_dir="cg_report.tsv" label="${tool.name} report">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
45 <filter>(stat == '--statout')</filter>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
46 </data>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
47 </outputs>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
48
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
49 <inputs>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
50 <!--form field to select crr file-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
51 <param name="crr" type="select" label="Reference genome (.crr file)">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
52 <options from_data_table="cg_crr_files" />
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
53 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
54
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
55 <!--conditional to select variant file input-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
56 <conditional name="data_sources">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
57 <param name="data_source" type="select" label="Where are the input junction files?">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
58 <option value="in" selected="true">imported into Galaxy</option>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
59 <option value="out">located outside Galaxy (data on server or mounted drive)</option>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
60 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
61
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
62 <!--form field to select junction files-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
63 <when value="in">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
64 <param name="inputA" type="data" format="tabluar" label="Junction file A">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
65 <validator type="dataset_ok_validator" />
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
66 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
67 metadata_name="dbkey" metadata_column="1"
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
68 message="cgatools is not currently available for this build."/>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
69 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
70 <param name="inputB" type="data" format="tabluar" label="Junction file B">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
71 <validator type="dataset_ok_validator" />
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
72 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
73 metadata_name="dbkey" metadata_column="1"
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
74 message="cgatools is not currently available for this build."/>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
75 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
76 </when>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
77
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
78 <!--form field to enter external input files-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
79 <when value="out">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
80 <param name="inputA" type="text" label="Junction file A (/path/junction_file)" size="40" help="e.g. /harddrive/GS00000XXXX-DID/GS00000YYYY-ASM/GS00123-DNA_G01_2000/ASM/SV/allJunctionsBeta-GS00000YYYY-ASM.tsv">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
81 <validator type="empty_field" message="You must supply a junction file"/>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
82 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
83 <param name="inputB" type="text" label="Junction file B (/path/junction_file)" size="40" help="e.g. /harddrive/GS00000XXXX-DID/GS00000YYYY-ASM/GS00123-DNA_G01_2000/ASM/SV/allJunctionsBeta-GS00000YYYY-ASM.tsv">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
84 <validator type="empty_field" message="You must supply a junction file"/>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
85 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
86 </when>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
87 </conditional>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
88
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
89 <!--form field to select stats output-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
90 <param name="stat" type="select" label="Print input file stats">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
91 <option value="">no</option>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
92 <option value="--statout">yes</option>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
93 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
94
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
95 <!--other parameters-->
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
96 <param name="scoreA" type="integer" label="Score threshold value for input file A (default 10)" value="10">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
97 <validator type="empty_field" message="You must enter a value, the default is 10" />
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
98 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
99 <param name="scoreB" type="integer" label="Score threshold value for input file B (default 0)" value="0">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
100 <validator type="empty_field" message="You must enter a value, the default is 0" />
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
101 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
102 <param name="distance" type="integer" label="Max distance between coordinates of potentially compatible junctions (default 200)" value="200">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
103 <validator type="empty_field" message="You must enter a value, the default is 200" />
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
104 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
105 <param name="minlength" type="integer" label="Minimum deletion junction length to be included into the difference file (default 500)" value="500">
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
106 <validator type="empty_field" message="You must enter a value, the default is 500" />
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
107 </param>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
108 </inputs>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
109
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
110
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
111 <help>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
112
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
113 **What it does**
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
114
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
115 This tool uses cgatools junctiondiff to report difference between junction calls of two Complete Genomics junctions files
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
116
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
117 **cgatools 1.6.0 Documentation**
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
118
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
119 Userguide: http://cgatools.sourceforge.net/docs/1.6.0/cgatools-user-guide.pdf
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
120
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
121 Release notes: http://cgatools.sourceforge.net/docs/1.6.0/cgatools-release-notes.pdf
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
122
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
123 **Command line reference**::
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
124
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
125 COMMAND NAME
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
126 junctiondiff - Reports difference between junction calls of Complete Genomics junctions files.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
127
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
128 DESCRIPTION
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
129 junctiondiff takes two junction files A and B as input and produces the
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
130 following output:
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
131 - "diff-inputFileName" - the junctions from an input file A that are not
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
132 present in input file B.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
133 - "report.txt" - a brief summary report (if --statout is used)
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
134
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
135 Two junctions are considered equivalent if:
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
136 - they come from different files
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
137 - left and right positions of one junction are not more than "--distance"
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
138 bases apart from the corresponding positions of another junction
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
139 - the junction scores are equal or above the scoreThreshold
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
140 - they are on the same strands
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
141
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
142 OPTIONS
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
143 -h [ --help ]
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
144 Print this help message.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
145
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
146 --beta
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
147 This is a beta command. To run this command, you must pass the --beta
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
148 flag.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
149
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
150 -s [ --reference ] arg
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
151 Reference file.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
152
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
153 -a [ --junctionsA ] arg
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
154 input junction file A.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
155
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
156 -b [ --junctionsB ] arg
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
157 input junction file B.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
158
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
159 -A [ --scoreThresholdA ] arg (=10)
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
160 score threshold value for the input file A.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
161
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
162 -B [ --scoreThresholdB ] arg (=0)
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
163 score threshold value for the input file B.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
164
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
165 -d [ --distance ] arg (=200)
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
166 Max distance between coordinates of potentially compatible junctions.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
167
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
168 -l [ --minlength ] arg (=500)
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
169 Minimum deletion junction length to be included into the difference
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
170 file.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
171
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
172 -o [ --output-prefix ] arg
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
173 The path prefix for all the output reports.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
174
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
175 -S [ --statout ]
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
176 (Debug) Report various input file statistics. Experimental feature.
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
177
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
178 SUPPORTED FORMAT_VERSION
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
179 1.5 or later
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
180 </help>
ef23f9cd599b Uploaded
devteam
parents:
diff changeset
181 </tool>