annotate cgatools/tools/cgatools_1.6/junctiondiff.xml @ 23:982e19c29ec0 draft default tip

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