annotate CG_cgatools/tools/cgatools/junctiondiff.xml @ 0:ffb2b0244ab2 draft

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