annotate cuffmerge_wrapper.xml @ 12:1707a530e598 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
author devteam
date Tue, 07 Feb 2017 18:39:42 -0500
parents b6e3849293b1
children cf747d1bd79a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
1 <tool id="cuffmerge" name="Cuffmerge" version="@VERSION@.0">
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description>merge together several Cufflinks assemblies</description>
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
3 <macros>
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
4 <import>cuff_macros.xml</import>
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
5 </macros>
12
1707a530e598 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 10
diff changeset
6 <expand macro="requirements" />
1707a530e598 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 10
diff changeset
7 <expand macro="stdio" />
1707a530e598 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 10
diff changeset
8 <command>
1707a530e598 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 10
diff changeset
9 python '$__tool_directory__/cuffmerge_wrapper.py'
8
5543c3d33e26 Convert tool to use $GALAXY_SLOTS if available.
Nate Coraor <nate@bx.psu.edu>
parents: 6
diff changeset
10 --num-threads="\${GALAXY_SLOTS:-4}"
0
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":
12
1707a530e598 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 10
diff changeset
14 -g '${annotation.reference_annotation}'
0
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":
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
19 -s
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
20 #if $seq_data.seq_source.index_source == "history":
12
1707a530e598 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 10
diff changeset
21 --ref_file '${seq_data.seq_source.ref_file}'
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
22 #else:
12
1707a530e598 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 10
diff changeset
23 --index '${seq_data.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
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
26
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
27 --min-isoform-fraction="${min_isoform_fraction}"
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
28
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
29 ## Outputs.
12
1707a530e598 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/cuffmerge commit eb18f691975ef9539b5ebd4f118343c8ad967a1f
devteam
parents: 10
diff changeset
30 --merged-transcripts '${merged_transcripts}'
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
31
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
32 @CUFFLINKS_GTF_INPUTS@
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
33 </command>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
34 <inputs>
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
35 <expand macro="cufflinks_gtf_inputs" />
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
36 <conditional name="annotation">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
37 <param name="use_ref_annotation" type="select" label="Use Reference Annotation">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
38 <option value="No">No</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
39 <option value="Yes">Yes</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
40 </param>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
41 <when value="Yes">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
42 <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
43 </when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
44 <when value="No">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
45 </when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
46 </conditional>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
47 <conditional name="seq_data">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
48 <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
49 <option value="No">No</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
50 <option value="Yes">Yes</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
51 </param>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
52 <when value="No"></when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
53 <when value="Yes">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
54 <conditional name="seq_source">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
55 <param name="index_source" type="select" label="Choose the source for the reference list">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
56 <option value="cached">Locally cached</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
57 <option value="history">History</option>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
58 </param>
2
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
59 <when value="cached">
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
60 <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
61 <options from_data_table="fasta_indexes">
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
62 <filter type="data_meta" ref="inputs" key="dbkey" column="1" />
2
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
63 <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
64 </options>
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
65 </param>
5b285b6e4ee3 Update to the new data table specification.
Dave Bouvier <dave@bx.psu.edu>
parents: 0
diff changeset
66 </when>
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
67 <when value="history">
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
68 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
69 </when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
70 </conditional>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
71 </when>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
72 </conditional>
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
73 <param name="min_isoform_fraction" type="float" min="0" max="1" value="0.05" label="Minimum isoform fraction" help="Discard isoforms with abundance below this value" />
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
74 </inputs>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
75
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
76 <outputs>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
77 <data format="gtf" name="merged_transcripts" label="${tool.name} on ${on_string}: merged transcripts"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
78 </outputs>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
79
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
80 <tests>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
81 <!--
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
82 cuffmerge -g cuffcompare_in3.gtf cuffcompare_in1.gtf cuffcompare_in2.gtf
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
83 -->
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
84 <test>
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
85 <param name="inputs" value="cuffcompare_in1.gtf,cuffcompare_in2.gtf" ftype="gtf"/>
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
86 <param name="use_ref_annotation" value="Yes"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
87 <param name="reference_annotation" value="cuffcompare_in3.gtf" ftype="gtf"/>
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
88 <param name="min_isoform_fraction" value="0.08" />
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
89 <param name="use_seq_data" value="No"/>
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
90 <!-- oId assignment differ/are non-deterministic -->
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
91 <output name="merged_transcripts" file="cuffmerge_out1.gtf" lines_diff="50"/>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
92 </test>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
93 </tests>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
94
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
95 <help>
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
96 **Cuffmerge Overview**
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
97
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
98 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
99
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
100 .. _Cufflinks: http://cole-trapnell-lab.github.io/cufflinks/
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
101
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
102 ------
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
103
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
104 **Know what you are doing**
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
105
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
106 .. class:: warningmark
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
107
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
108 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
109
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
110 .. __: http://cole-trapnell-lab.github.io/cufflinks/cuffmerge/
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
111
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
112 ------
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
113
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
114 **Input format**
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
115
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
116 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
117
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
118 .. _Ensembl: http://www.ensembl.org
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
119
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
120 ------
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
121
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
122 **Outputs**
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
123
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
124 Cuffmerge produces the following output files:
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
125
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
126 Merged transcripts file:
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
127
10
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
128 Cuffmerge produces a GTF file that contains an assembly that merges together the input assemblies.
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
129 </help>
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
130 <citations>
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
131 <citation type="doi">10.1038/nbt.1621</citation>
b6e3849293b1 Uploaded
devteam
parents: 9
diff changeset
132 </citations>
0
dbbd37e013aa Uploaded tool tarball.
devteam
parents:
diff changeset
133 </tool>