annotate cuffmerge_wrapper.xml @ 2:5b285b6e4ee3

Update to the new data table specification.
author Dave Bouvier <dave@bx.psu.edu>
date Wed, 04 Dec 2013 13:24:59 -0500
parents dbbd37e013aa
children 68eaaae05c51
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
1 <tool id="cuffmerge" name="Cuffmerge" version="0.0.6">
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
2 <!-- Wrapper supports Cuffmerge versions 1.3 and newer -->
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
3 <description>merge together several Cufflinks assemblies</description>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirements>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
5 <requirement type="package" version="2.1.1">cufflinks</requirement>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
6 </requirements>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
7 <command interpreter="python">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
8 cuffmerge_wrapper.py
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
9
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
10 --num-threads="4"
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
11
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
12 ## Use annotation reference?
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
13 #if $annotation.use_ref_annotation == "Yes":
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
14 -g $annotation.reference_annotation
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
15 #end if
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
16
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
17 ## Use sequence data?
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
18 #if $seq_data.use_seq_data == "Yes":
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
19 -s
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
20 #if $seq_data.seq_source.index_source == "history":
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
21 --ref_file=$seq_data.seq_source.ref_file
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
22 #else:
2
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
23 --index=${bias_correction.seq_source.index.fields.path}
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
24 #end if
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
25 #end if
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
26
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
27 ## Outputs.
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
28 --merged-transcripts=${merged_transcripts}
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
29
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
30 ## Inputs.
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
31 ${first_input}
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
32 #for $input_file in $input_files:
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
33 ${input_file.additional_input}
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
34 #end for
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
35
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
36 </command>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
37 <inputs>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
38 <param format="gtf" name="first_input" type="data" label="GTF file produced by Cufflinks" help=""/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
39 <repeat name="input_files" title="Additional GTF Input Files">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
40 <param format="gtf" name="additional_input" type="data" label="GTF file produced by Cufflinks" help=""/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
41 </repeat>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
42 <conditional name="annotation">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
43 <param name="use_ref_annotation" type="select" label="Use Reference Annotation">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
44 <option value="No">No</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
45 <option value="Yes">Yes</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
46 </param>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
47 <when value="Yes">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
48 <param format="gff3,gtf" name="reference_annotation" type="data" label="Reference Annotation" help="Requires an annotation file in GFF3 or GTF format."/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
49 </when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
50 <when value="No">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
51 </when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
52 </conditional>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
53 <conditional name="seq_data">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
54 <param name="use_seq_data" type="select" label="Use Sequence Data" help="Use sequence data for some optional classification functions, including the addition of the p_id attribute required by Cuffdiff.">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
55 <option value="No">No</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
56 <option value="Yes">Yes</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
57 </param>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
58 <when value="No"></when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
59 <when value="Yes">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
60 <conditional name="seq_source">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
61 <param name="index_source" type="select" label="Choose the source for the reference list">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
62 <option value="cached">Locally cached</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
63 <option value="history">History</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
64 </param>
2
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
65 <when value="cached">
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
66 <param name="index" type="select" label="Using reference genome">
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
67 <options from_data_table="fasta_indexes">
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
68 <filter type="data_meta" ref="input" key="dbkey" column="1" />
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
69 <validator type="no_options" message="No reference genome is available for the build associated with the selected input dataset" />
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
70 </options>
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
71 </param>
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
72 </when>
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
73 <when value="history">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
74 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
75 </when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
76 </conditional>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
77 </when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
78 </conditional>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
79 </inputs>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
80
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
81 <outputs>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
82 <data format="gtf" name="merged_transcripts" label="${tool.name} on ${on_string}: merged transcripts"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
83 </outputs>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
84
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
85 <tests>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
86 <!--
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
87 cuffmerge -g cuffcompare_in3.gtf cuffcompare_in1.gtf cuffcompare_in2.gtf
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
88 -->
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
89 <test>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
90 <param name="first_input" value="cuffcompare_in1.gtf" ftype="gtf"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
91 <param name="additional_input" value="cuffcompare_in2.gtf" ftype="gtf"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
92 <param name="use_ref_annotation" value="Yes"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
93 <param name="reference_annotation" value="cuffcompare_in3.gtf" ftype="gtf"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
94 <param name="use_seq_data" value="No"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
95 <!-- oId assignment differ/are non-deterministic -->
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
96 <output name="merged_transcripts" file="cuffmerge_out1.gtf" lines_diff="50"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
97 </test>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
98 </tests>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
99
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
100 <help>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
101 **Cuffmerge Overview**
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
102
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
103 Cuffmerge is part of Cufflinks_. 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
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
104
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
105 .. _Cufflinks: http://cufflinks.cbcb.umd.edu/
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
106
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
107 ------
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
108
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
109 **Know what you are doing**
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
110
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
111 .. class:: warningmark
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
112
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
113 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.
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
114
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
115 .. __: http://cufflinks.cbcb.umd.edu/manual.html#cuffmerge
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
116
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
117 ------
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
118
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
119 **Input format**
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
120
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
121 Cuffmerge takes Cufflinks' GTF output as input, and optionally can take a "reference" annotation (such as from Ensembl_)
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
122
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
123 .. _Ensembl: http://www.ensembl.org
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
124
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
125 ------
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
126
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
127 **Outputs**
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
128
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
129 Cuffmerge produces the following output files:
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
130
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
131 Merged transcripts file:
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
132
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
133 Cuffmerge produces a GTF file that contains an assembly that merges together the input assemblies. </help>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
134 </tool>