annotate cgatools/tools/cg_cgatools/junctiondiff.xml @ 12:e59abf6c3d0b draft

Uploaded
author bcrain-completegenomics
date Thu, 14 Jun 2012 13:44:48 -0400
parents e183f52194a5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
1 <tool id="cga_junctiondiff" name="junctiondiff(beta)" version="0.0.1">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
2
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
3 <description>reports difference between junction calls</description> <!--adds description in toolbar-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
4
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
5 <requirements>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
6 <requirement type="binary">cgatools</requirement>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
7 </requirements>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
8
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
9 <command> <!--run executable-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
10 cgatools junctiondiff --beta
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
11 --reference $crr.fields.path
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
12 --junctionsA $data_sources.inputA
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
13 --junctionsB $data_sources.inputB
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
14 --scoreThresholdA $scoreA
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
15 --scoreThresholdB $scoreB
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
16 --distance $distance
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
17 --minlength $minlength
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
18 $stat
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
19 --output-prefix cg_
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
20 ;
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
21 mv cg_diff-*tsv cg_diff.tsv
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
22 </command>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
23
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
24 <outputs>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
25 <data format="tabular" name="output1" from_work_dir="cg_diff.tsv" label="${tool.name} on ${on_string}: diff"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
26 <data format="tabular" name="output2" from_work_dir="cg_report.tsv" label="${tool.name} on ${on_string}: report">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
27 <filter>(stat == '--statout')</filter>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
28 </data>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
29 </outputs>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
30
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
31 <inputs>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
32 <!--form field to select crr file-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
33 <param name="crr" type="select" label="Genome build">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
34 <options from_data_table="cg_crr_files" />
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
35 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
36
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
37 <!--conditional to select variant file input-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
38 <conditional name="data_sources">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
39 <param name="data_source" type="select" label="Where are the input junction files?">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
40 <option value="in" selected="true">imported into Galaxy</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
41 <option value="out">located outside Galaxy (available only for local Galaxy instances)</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
42 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
43 <when value="in">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
44 <!--form field to select variant files-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
45 <param name="inputA" type="data" format="tabluar" label="Junction file A">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
46 <validator type="unspecified_build" />
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
47 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
48 metadata_name="dbkey" metadata_column="1"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
49 message="cgatools is not currently available for this build."/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
50 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
51 <param name="inputB" type="data" format="tabluar" label="Junction file B">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
52 <validator type="unspecified_build" />
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
53 <validator type="dataset_metadata_in_file" filename="cg_crr_files.loc"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
54 metadata_name="dbkey" metadata_column="1"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
55 message="cgatools is not currently available for this build."/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
56 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
57 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
58 <when value="out">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
59 <!--form field to enter external input files-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
60 <param name="inputA" type="text" label="Junction file A (path/file_name)" size="40" help="Junction file can be compressed (gz, bz2)."/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
61 <param name="inputB" type="text" label="Junction file B (path/file_name)" size="40" help="Junction file can be compressed (gz, bz2)."/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
62 </when>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
63 </conditional>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
64
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
65 <!--form field to select stats output-->
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
66 <param name="stat" type="select" label="Print input file stats">
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
67 <option value="">no</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
68 <option value="--statout">yes</option>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
69 </param>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
70
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
71 <param name="scoreA" type="integer" label="Score threshold value for input file A (default 10)" value="10"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
72 <param name="scoreB" type="integer" label="Score threshold value for input file B (default 0)" value="0"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
73 <param name="distance" type="integer" label="Max distance between coordinates of potentially compatible junctions (default 200)" value="200"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
74 <param name="minlength" type="integer" label="Minimum deletion junction length to be included into the difference file (default 500)" value="500"/>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
75 </inputs>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
76
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
77
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
78 <help>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
79
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
80 **What it does**
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
81
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
82 This tool reports difference between junction calls of Complete Genomics junctions files
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
83
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
84 cgatools: http://sourceforge.net/projects/cgatools/files/
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
85
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
86 -----
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
87
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
88 **cgatools Manual**::
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
89
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
90 COMMAND NAME
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
91 junctiondiff - Reports difference between junction calls of Complete Genomics junctions files.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
92
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
93 DESCRIPTION
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
94 junctiondiff takes two junction files A and B as input and produces the
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
95 following output:
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
96 - "diff-inputFileName" - the junctions from an input file A that are not
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
97 present in input file B.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
98 - "report.txt" - a brief summary report (if --statout is used)
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
99
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
100 Two junctions are considered equivalent if:
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
101 - they come from different files
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
102 - left and right positions of one junction are not more than "--distance"
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
103 bases apart from the corresponding positions of another junction
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
104 - the junction scores are equal or above the scoreThreshold
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
105 - they are on the same strands
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
106
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
107 OPTIONS
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
108 -h [ --help ]
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
109 Print this help message.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
110
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
111 --beta
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
112 This is a beta command. To run this command, you must pass the --beta
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
113 flag.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
114
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
115 -s [ --reference ] arg
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
116 Reference file.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
117
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
118 -a [ --junctionsA ] arg
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
119 input junction file A.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
120
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
121 -b [ --junctionsB ] arg
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
122 input junction file B.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
123
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
124 -A [ --scoreThresholdA ] arg (=10)
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
125 score threshold value for the input file A.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
126
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
127 -B [ --scoreThresholdB ] arg (=0)
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
128 score threshold value for the input file B.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
129
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
130 -d [ --distance ] arg (=200)
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
131 Max distance between coordinates of potentially compatible junctions.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
132
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
133 -l [ --minlength ] arg (=500)
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
134 Minimum deletion junction length to be included into the difference
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
135 file.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
136
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
137 -o [ --output-prefix ] arg
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
138 The path prefix for all the output reports.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
139
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
140 -S [ --statout ]
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
141 (Debug) Report various input file statistics. Experimental feature.
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
142
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
143 SUPPORTED FORMAT_VERSION
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
144 1.5 or later
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
145 </help>
e183f52194a5 Uploaded
bcrain-completegenomics
parents:
diff changeset
146 </tool>