annotate cgatools_suite/tools/cgatools/junctiondiff.xml @ 9:326dbb82d58b draft

Uploaded
author bcrain-completegenomics
date Wed, 06 Jun 2012 17:04:11 -0400
parents 96829b1b73ea
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
1 <tool id="cga_junctiondiff" name="junctiondiff(beta)" version="0.0.1">
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
2
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
3 <description>reports difference between junction calls</description> <!--adds description in toolbar-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
4
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
5 <requirements>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
6 <requirement type="binary">cgatools</requirement>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
7 </requirements>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
8
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
9 <command> <!--run executable-->
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
10 cgatools junctiondiff --beta -h
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
11 </command>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
12
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
13 <outputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
14 <data format="tabular" name="output" />
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
15 </outputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
16
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
17 <inputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
18 </inputs>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
19
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
20 <help>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
21
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
22 **What it does**
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
23
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
24 This tool reports difference between junction calls of Complete Genomics junctions files
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
25
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
26 cgatools: http://sourceforge.net/projects/cgatools/files/
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
27
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
28 -----
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
29
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
30 **cgatools Manual**::
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
31
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
32 COMMAND NAME
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
33 junctiondiff - Reports difference between junction calls of Complete Genomics junctions files.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
34
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
35 DESCRIPTION
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
36 junctiondiff takes two junction files A and B as input and produces the
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
37 following output:
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
38 - "diff-inputFileName" - the junctions from an input file A that are not
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
39 present in input file B.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
40 - "report.txt" - a brief summary report (if --statout is used)
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
41
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
42 Two junctions are considered equivalent if:
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
43 - they come from different files
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
44 - left and right positions of one junction are not more than "--distance"
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
45 bases apart from the corresponding positions of another junction
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
46 - the junction scores are equal or above the scoreThreshold
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
47 - they are on the same strands
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
48
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
49 OPTIONS
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
50 -h [ --help ]
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
51 Print this help message.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
52
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
53 --beta
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
54 This is a beta command. To run this command, you must pass the --beta
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
55 flag.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
56
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
57 -s [ --reference ] arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
58 Reference file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
59
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
60 -a [ --junctionsA ] arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
61 input junction file A.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
62
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
63 -b [ --junctionsB ] arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
64 input junction file B.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
65
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
66 -A [ --scoreThresholdA ] arg (=10)
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
67 score threshold value for the input file A.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
68
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
69 -B [ --scoreThresholdB ] arg (=0)
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
70 score threshold value for the input file B.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
71
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
72 -d [ --distance ] arg (=200)
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
73 Max distance between coordinates of potentially compatible junctions.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
74
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
75 -l [ --minlength ] arg (=500)
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
76 Minimum deletion junction length to be included into the difference
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
77 file.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
78
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
79 -o [ --output-prefix ] arg
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
80 The path prefix for all the output reports.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
81
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
82 -S [ --statout ]
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
83 (Debug) Report various input file statistics. Experimental feature.
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
84
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
85 SUPPORTED FORMAT_VERSION
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
86 1.5 or later
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
87 </help>
96829b1b73ea Uploaded
bcrain-completegenomics
parents:
diff changeset
88 </tool>