annotate cgatools/tools/cgatools_1.5/junctiondiff.xml @ 18:09d478f7a885 draft

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