annotate cuffcompare_wrapper.xml @ 9:e66b9b5b8580 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
author devteam
date Sun, 19 Feb 2017 12:12:05 -0500
parents 1322b73ffe44
children f648e5180e40
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
1 <tool id="cuffcompare" name="Cuffcompare" version="@VERSION@.1">
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description>compare assembled transcripts to a reference annotation and track Cufflinks transcripts across multiple experiments</description>
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
3 <macros>
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
4 <import>cuff_macros.xml</import>
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
5 </macros>
8
1322b73ffe44 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 7
diff changeset
6 <expand macro="requirements" />
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
7 <version_command>cuffcompare 2>&amp;1 | head -n 1</version_command>
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
8 <command detect_errors="aggressive"><![CDATA[
8
1322b73ffe44 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 7
diff changeset
9 python '$__tool_directory__/cuffcompare_wrapper.py'
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
10 ## Use annotation reference?
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
11 #if $annotation.use_ref_annotation == "Yes":
8
1322b73ffe44 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 7
diff changeset
12 -r '$annotation.reference_annotation'
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
13 #if $annotation.ignore_nonoverlapping_reference:
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
14 -R
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
15 #end if
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
16 #if $annotation.ignore_nonoverlapping_transfrags:
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
17 -Q
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
18 #end if
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
19
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
20 #end if
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
21
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
22 ## Use sequence data?
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
23 #if $seq_data.use_seq_data == "Yes":
2
8b22e9adae34 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
24 -s
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
25 #if $seq_data.seq_source.index_source == "history":
8
1322b73ffe44 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 7
diff changeset
26 --ref_file '$seq_data.seq_source.ref_file'
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
27 #else:
8
1322b73ffe44 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 7
diff changeset
28 --index '${seq_data.seq_source.index.fields.path}'
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
29 #end if
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
30 #end if
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
31
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
32 $discard_single_exon
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
33
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
34 -e $max_dist_exon
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
35 -d $max_dist_group
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
36
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
37 #if $discard_intron_redundant_transfrags:
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
38 -F
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
39 #end if
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
40
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
41 ## Outputs.
8
1322b73ffe44 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 7
diff changeset
42 --combined-transcripts '${transcripts_combined}'
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
43
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
44 @CUFFLINKS_GTF_INPUTS@
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
45 ]]></command>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
46 <inputs>
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
47 <expand macro="cufflinks_gtf_inputs" />
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
48 <conditional name="annotation">
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
49 <param name="use_ref_annotation" type="select" label="Use Reference Annotation">
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
50 <option value="No">No</option>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
51 <option value="Yes">Yes</option>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
52 </param>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
53 <when value="Yes">
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
54 <param format="gff3,gtf" name="reference_annotation" type="data" label="Reference Annotation" help="Requires an annotation file in GFF3 or GTF format."/>
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
55 <param name="ignore_nonoverlapping_reference" type="boolean" label="Ignore reference transcripts that are not overlapped by any input transfrags" help="consider only the reference transcripts that overlap any of the input transfrags (Sn correction)" />
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
56 <param name="ignore_nonoverlapping_transfrags" type="boolean" label="Ignore input transcripts that are not overlapped by any reference transcripts" help="consider only the input transcripts that overlap any of the reference transcripts (Sp correction). Warning: this will discard all 'novel' loci!" />
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
57 </when>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
58 <when value="No">
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
59 </when>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
60 </conditional>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
61 <conditional name="seq_data">
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
62 <param name="use_seq_data" type="select" label="Use Sequence Data"
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
63 help="Use sequence data for some optional classification functions, including the addition of the p_id attribute required by Cuffdiff.">
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
64 <option value="Yes">Yes</option>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
65 <option value="No">No</option>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
66 </param>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
67 <when value="No"></when>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
68 <when value="Yes">
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
69 <conditional name="seq_source">
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
70 <param name="index_source" type="select" label="Choose the source for the reference list">
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
71 <option value="cached">Locally cached</option>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
72 <option value="history">History</option>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
73 </param>
2
8b22e9adae34 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
74 <when value="cached">
8b22e9adae34 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
75 <param name="index" type="select" label="Using reference genome">
8b22e9adae34 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
76 <options from_data_table="fasta_indexes">
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
77 <filter type="data_meta" ref="inputs" key="dbkey" column="1" />
2
8b22e9adae34 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
78 <validator type="no_options" message="No reference genome is available for the build associated with the selected input dataset" />
8b22e9adae34 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
79 </options>
8b22e9adae34 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
80 </param>
8b22e9adae34 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
81 </when>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
82 <when value="history">
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
83 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
84 </when>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
85 </conditional>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
86 </when>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
87 </conditional>
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
88 <param type="select" name="discard_single_exon" label="discard (ignore) single-exon transcripts">
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
89 <option value="" selected="True">No</option>
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
90 <option value="-M">Discard single-exon transfrags and reference transcripts</option>
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
91 <option value="-N">Discard single-exon reference transcripts</option>
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
92 </param>
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
93 <param type="integer" name="max_dist_exon" value="100" label="Max. Distance for assessing exon accuracy"
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
94 help="max. distance (range) allowed from free ends of terminal exons of reference transcripts when assessing exon accuracy. Default: 100" />
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
95 <param type="integer" name="max_dist_group" value="100" label="Max.Distance for transcript grouping"
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
96 help="max. distance (range) for grouping transcript start sites. Default: 100" />
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
97 <param type="boolean" name="discard_intron_redundant_transfrags" label="discard intron-redundant transfrags sharing 5'"
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
98 help="Discard intron-redundant transfrags if they share the 5' end (if they differ only at the 3' end)" />
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
99 </inputs>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
100
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
101 <outputs>
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
102 <data format="txt" name="transcripts_accuracy" label="${tool.name} on ${on_string}: transcript accuracy"
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
103 from_work_dir="cc_output.stats" />
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
104 <data format="tabular" name="input1_tmap" label="${tool.name} on ${on_string}: data ${inputs[0].hid} tmap file"
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
105 from_work_dir="cc_output.input1.tmap" />
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
106 <data format="tabular" name="input1_refmap"
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
107 label="${tool.name} on ${on_string}: data ${inputs[0].hid} refmap file"
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
108 from_work_dir="cc_output.input1.refmap">
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
109 <filter>annotation['use_ref_annotation'] == 'Yes'</filter>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
110 </data>
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
111 <data format="tabular" name="input2_tmap" label="${tool.name} on ${on_string}: data ${inputs[1].hid} tmap file" from_work_dir="cc_output.input2.tmap">
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
112 <filter>@HAS_MULTIPLE_INPUTS@</filter>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
113 </data>
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
114 <data format="tabular" name="input2_refmap"
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
115 label="${tool.name} on ${on_string}: data ${inputs[1].hid} refmap file"
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
116 from_work_dir="cc_output.input2.refmap">
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
117 <filter>annotation['use_ref_annotation'] == 'Yes' and @HAS_MULTIPLE_INPUTS@</filter>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
118 </data>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
119 <data format="tabular" name="transcripts_tracking" label="${tool.name} on ${on_string}: transcript tracking" from_work_dir="cc_output.tracking">
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
120 <filter>@HAS_MULTIPLE_INPUTS@</filter>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
121 </data>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
122 <data format="gtf" name="transcripts_combined" label="${tool.name} on ${on_string}: combined transcripts"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
123 </outputs>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
124
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
125 <tests>
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
126 <!--
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
127 cuffcompare -r cuffcompare_in3.gtf -R cuffcompare_in1.gtf cuffcompare_in2.gtf
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
128 -->
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
129 <test>
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
130 <param name="inputs" value="cuffcompare_in1.gtf,cuffcompare_in2.gtf" ftype="gtf"/>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
131 <param name="use_ref_annotation" value="Yes"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
132 <param name="reference_annotation" value="cuffcompare_in3.gtf" ftype="gtf"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
133 <param name="ignore_nonoverlapping_reference" value="Yes"/>
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
134 <param name="ignore_nonoverlapping_transfrags" value="No"/>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
135 <param name="use_seq_data" value="No"/>
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
136 <param name="discard_single_exon" value="" />
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
137 <param name="max_dist_exon" value="100" />
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
138 <param name="max_dist_group" value="100" />
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
139 <param name="discard_intron_redundant_transfrags" value="No" />
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
140 <!-- Line diffs are the result of different locations for input files; this cannot be fixed as cuffcompare outputs
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
141 full input path for each input. -->
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
142 <output name="transcripts_accuracy" file="cuffcompare_out7.txt" lines_diff="2"/>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
143 <output name="input1_tmap" file="cuffcompare_out1.tmap"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
144 <output name="input1_refmap" file="cuffcompare_out2.refmap"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
145 <output name="input2_tmap" file="cuffcompare_out3.tmap"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
146 <output name="input2_refmap" file="cuffcompare_out4.refmap"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
147 <output name="transcripts_tracking" file="cuffcompare_out6.tracking"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
148 <output name="transcripts_combined" file="cuffcompare_out5.gtf"/>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
149 </test>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
150 </tests>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
151
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
152 <help>
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
153 **Cuffcompare Overview**
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
154
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
155 Cuffcompare is part of Cufflinks_. Cuffcompare helps you: (a) compare your assembled transcripts to a reference annotation and (b) track Cufflinks transcripts across multiple experiments (e.g. across a time course). Please cite: Trapnell C, Williams BA, Pertea G, Mortazavi AM, Kwan G, van Baren MJ, Salzberg SL, Wold B, Pachter L. Transcript assembly and abundance estimation from RNA-Seq reveals thousands of new transcripts and switching among isoforms. Nature Biotechnology doi:10.1038/nbt.1621
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
156
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
157 .. _Cufflinks: http://cole-trapnell-lab.github.io/cufflinks/
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
158
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
159 ------
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
160
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
161 **Know what you are doing**
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
162
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
163 .. class:: warningmark
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
164
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
165 There is no such thing (yet) as an automated gearshift in expression analysis. It is all like stick-shift driving in San Francisco. In other words, running this tool with default parameters will probably not give you meaningful results. A way to deal with this is to **understand** the parameters by carefully reading the `documentation`__ and experimenting. Fortunately, Galaxy makes experimenting easy.
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
166
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
167 .. __: http://cole-trapnell-lab.github.io/cufflinks/cuffcompare/
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
168
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
169 ------
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
170
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
171 **Input format**
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
172
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
173 Cuffcompare takes Cufflinks' GTF output as input, and optionally can take a "reference" annotation (such as from Ensembl_)
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
174
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
175 .. _Ensembl: http://www.ensembl.org
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
176
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
177 ------
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
178
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
179 **Outputs**
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
180
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
181 Cuffcompare produces the following output files:
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
182
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
183 Transcripts Accuracy File:
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
184
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
185 Cuffcompare reports various statistics related to the "accuracy" of the transcripts in each sample when compared to the reference annotation data. The typical gene finding measures of "sensitivity" and "specificity" (as defined in Burset, M., Guigó, R. : Evaluation of gene structure prediction programs (1996) Genomics, 34 (3), pp. 353-367. doi: 10.1006/geno.1996.0298) are calculated at various levels (nucleotide, exon, intron, transcript, gene) for each input file and reported in this file. The Sn and Sp columns show specificity and sensitivity values at each level, while the fSn and fSp columns are "fuzzy" variants of these same accuracy calculations, allowing for a very small variation in exon boundaries to still be counted as a "match".
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
186
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
187 Transcripts Combined File:
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
188
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
189 Cuffcompare reports a GTF file containing the "union" of all transfrags in each sample. If a transfrag is present in both samples, it is thus reported once in the combined gtf.
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
190
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
191 Transcripts Tracking File:
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
192
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
193 This file matches transcripts up between samples. Each row contains a transcript structure that is present in one or more input GTF files. Because the transcripts will generally have different IDs (unless you assembled your RNA-Seq reads against a reference transcriptome), cuffcompare examines the structure of each the transcripts, matching transcripts that agree on the coordinates and order of all of their introns, as well as strand. Matching transcripts are allowed to differ on the length of the first and last exons, since these lengths will naturally vary from sample to sample due to the random nature of sequencing.
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
194 If you ran cuffcompare with the -r option, the first and second columns contain the closest matching reference transcript to the one described by each row.
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
195
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
196 Here's an example of a line from the tracking file::
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
197
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
198 TCONS_00000045 XLOC_000023 Tcea|uc007afj.1 j \
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
199 q1:exp.115|exp.115.0|100|3.061355|0.350242|0.350207 \
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
200 q2:60hr.292|60hr.292.0|100|4.094084|0.000000|0.000000
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
201
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
202 In this example, a transcript present in the two input files, called exp.115.0 in the first and 60hr.292.0 in the second, doesn't match any reference transcript exactly, but shares exons with uc007afj.1, an isoform of the gene Tcea, as indicated by the class code j. The first three columns are as follows::
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
203
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
204 Column number Column name Example Description
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
205 -----------------------------------------------------------------------
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
206 1 Cufflinks transfrag id TCONS_00000045 A unique internal id for the transfrag
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
207 2 Cufflinks locus id XLOC_000023 A unique internal id for the locus
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
208 3 Reference gene id Tcea The gene_name attribute of the reference GTF record for this transcript, or '-' if no reference transcript overlaps this Cufflinks transcript
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
209 4 Reference transcript id uc007afj.1 The transcript_id attribute of the reference GTF record for this transcript, or '-' if no reference transcript overlaps this Cufflinks transcript
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
210 5 Class code c The type of match between the Cufflinks transcripts in column 6 and the reference transcript. See class codes
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
211
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
212 Each of the columns after the fifth have the following format:
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
213 qJ:gene_id|transcript_id|FMI|FPKM|conf_lo|conf_hi
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
214
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
215 A transcript need be present in all samples to be reported in the tracking file. A sample not containing a transcript will have a "-" in its entry in the row for that transcript.
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
216
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
217 Class Codes
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
218
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
219 If you ran cuffcompare with the -r option, tracking rows will contain the following values. If you did not use -r, the rows will all contain "-" in their class code column::
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
220
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
221 Priority Code Description
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
222 ---------------------------------
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
223 1 = Match
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
224 2 c Contained
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
225 3 j New isoform
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
226 4 e A single exon transcript overlapping a reference exon and at least 10 bp of a reference intron, indicating a possible pre-mRNA fragment.
7
b77178f66fc3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
227 5 i A single exon transcript falling entirely with a reference intron
b77178f66fc3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
228 6 o Generic exonic overlap with a reference transcript
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
229 7 p Possible polymerase run-on fragment
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
230 8 r Repeat. Currently determined by looking at the soft-masked reference sequence and applied to transcripts where at least 50% of the bases are lower case
7
b77178f66fc3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
231 9 u Unknown, intergenic transcript
b77178f66fc3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
232 10 x Exonic overlap with reference on the opposite strand
b77178f66fc3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
233 11 s An intron of the transfrag overlaps a reference intron on the opposite strand (likely due to read mapping errors)
b77178f66fc3 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
234 12 . (.tracking file only, indicates multiple classifications)
9
e66b9b5b8580 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffcompare commit 82ee6fc860c52c531b7a57bbb346ab1a67a434a5
devteam
parents: 8
diff changeset
235
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
236 -------
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
237
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
238 **Settings**
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
239
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
240 All of the options have a default value. You can change any of them. Most of the options in Cuffcompare have been implemented here.
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
241
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
242 ------
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
243
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
244 **Cuffcompare parameter list**
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
245
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
246 This is a list of implemented Cuffcompare options::
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
247
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
248 -r An optional "reference" annotation GTF. Each sample is matched against this file, and sample isoforms are tagged as overlapping, matching, or novel where appropriate. See the refmap and tmap output file descriptions below.
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
249 -R If -r was specified, this option causes cuffcompare to ignore reference transcripts that are not overlapped by any transcript in one of cuff1.gtf,...,cuffN.gtf. Useful for ignoring annotated transcripts that are not present in your RNA-Seq samples and thus adjusting the "sensitivity" calculation in the accuracy report written in the transcripts_accuracy file
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
250 </help>
6
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
251 <citations>
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
252 <citation type="doi">10.1038/nbt.1621</citation>
8e534225baa9 Uploaded
devteam
parents: 2
diff changeset
253 </citations>
0
9d35cf35634e Uploaded tool tarball.
devteam
parents:
diff changeset
254 </tool>