annotate tools/clc_assembly_cell/clc_assembler.xml @ 0:0996169ac2e8 draft

Uploaded v0.0.2, previously only on the TestToolShed
author peterjc
date Fri, 21 Nov 2014 06:41:12 -0500
parents
children 5ae1c0312aaa
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
1 <tool id="clc_assembler" name="CLC assembler" version="0.0.2">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
2 <description>Assembles reads giving a FASTA file</description>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
3 <requirements>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
4 <requirement type="binary">clc_assembler</requirement>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
5 </requirements>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
6 <version_command>\${CLC_ASSEMBLY_CELL:-/mnt/apps/clcBio/clc-assembly-cell-4.1.0-linux_64/}clc_assembler | grep -i version</version_command>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
7 <command>\${CLC_ASSEMBLY_CELL:-/mnt/apps/clcBio/clc-assembly-cell-4.1.0-linux_64/}clc_assembler
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
8 #for $rg in $read_group
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
9 ##--------------------------------------
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
10 #if str($rg.segments.type) == "paired"
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
11 -p $rg.segments.placement $rg.segments.dist_mode $rg.segments.min_size $rg.segments.max_size -q -i "$rg.segments.filename1" "$rg.segments.filename2"
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
12 #end if
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
13 ##--------------------------------------
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
14 #if str($rg.segments.type) == "interleaved"
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
15 -p $rg.segments.placement $rg.segments.dist_mode $rg.segments.min_size $rg.segments.max_size -q "$rg.segments.filename"
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
16 #end if
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
17 ##--------------------------------------
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
18 #if str($rg.segments.type) == "none"
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
19 -p no -q
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
20 #for $f in $rg.segments.filenames
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
21 "$f"
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
22 #end for
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
23 #end if
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
24 ##--------------------------------------
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
25 #end for
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
26 -m $min_contig_len
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
27 -o "$out_fasta"
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
28 --cpus \${GALAXY_SLOTS:-4}
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
29 -v | grep -v "^Progress: "</command>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
30 <stdio>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
31 <!-- Assume anything other than zero is an error -->
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
32 <exit_code range="1:" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
33 <exit_code range=":-1" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
34 </stdio>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
35 <inputs>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
36 <repeat name="read_group" title="Read Group" min="1">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
37 <conditional name="segments">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
38 <param name="type" type="select" label="Are these paired reads?">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
39 <option value="paired">Paired reads (as two files)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
40 <option value="interleaved">Paired reads (as one interleaved file)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
41 <option value="none">Unpaired reads (single or orphan reads)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
42 </param>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
43 <when value="paired">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
44 <param name="placement" type="select" label="Pairing type (segment placing)">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
45 <option value="fb">---&gt; &lt;--- (e.g. Sanger capillary or Solexa/Illumina paired-end library)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
46 <option value="bf">&lt;--- ---&gt; (e.g. Solexa/Illumina mate-pair library)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
47 <option value="ff">---&gt; ---&gt;</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
48 <option value="bb">&lt;--- &lt;---</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
49 </param>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
50 <param name="dist_mode" type="select" label="How is the fragment distance measured?">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
51 <option value="ss">Start to start (e.g. Sanger capillary or Solexa/Illumina libraries)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
52 <option value="se">Start to end</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
53 <option value="es">End to start</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
54 <option value="ee">End to end</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
55 </param>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
56 <!-- TODO - min/max validation done via the <code> tag? -->
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
57 <param name="min_size" type="integer" optional="false" min="0" value=""
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
58 label="Minimum size of 'good' DNA templates in the library preparation" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
59 <param name="max_size" type="integer" optional="false" min="0" value=""
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
60 label="Maximum size of 'good' DNA templates in the library preparation" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
61 <param name="filename1" type="data" format="fastq,fasta" required="true" label="Read file one"/>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
62 <param name="filename2" type="data" format="fastq,fasta" required="true" label="Read file two"/>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
63 </when>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
64 <when value="interleaved">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
65 <param name="placement" type="select" label="Pairing type (segment placing)">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
66 <option value="fb">---&gt; &lt;--- (e.g. Sanger capillary or Solexa/Illumina paired-end library)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
67 <option value="bf">&lt;--- ---&gt; (e.g. Solexa/Illumina mate-pair library)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
68 <option value="ff">---&gt; ---&gt;</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
69 <option value="bb">&lt;-- &lt;--</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
70 </param>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
71 <param name="dist_mode" type="select" label="How is the fragment distance measured?">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
72 <option value="ss">Start to start (e.g. Sanger capillary or Solexa/Illumina libraries)</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
73 <option value="se">Start to end</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
74 <option value="es">End to start</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
75 <option value="ee">End to end</option>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
76 </param>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
77 <!-- TODO - min/max validation done via the <code> tag? -->
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
78 <param name="min_size" type="integer" optional="false" min="0" value=""
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
79 label="Minimum size of 'good' DNA templates in the library preparation" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
80 <param name="max_size" type="integer" optional="false" min="0" value=""
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
81 label="Maximum size of 'good' DNA templates in the library preparation" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
82 <param name="filename" type="data" format="fastq,fasta" required="true" label="Interleaved read file"/>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
83 </when>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
84 <when value="none">
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
85 <param name="filenames" type="data" format="fastq,fasta" multiple="true" required="true" label="Read file(s)"
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
86 help="Multiple files allowed, for example several files of orphan reads." />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
87 </when>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
88 </conditional>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
89 </repeat>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
90 <param name="min_contig_len" type="integer" optional="false" min="1" value="200" label="Minimum contig length"/>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
91 <!-- Word size? -->
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
92 <!-- Bubble size? -->
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
93 <!-- Scaffolding options? -->
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
94 <!-- AGP / GFF output? -->
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
95 </inputs>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
96 <!-- min/max validation? <code file="clc_validator.py" /> -->
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
97 <outputs>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
98 <data name="out_fasta" format="fasta" label="CLCbio assember contigs (FASTA)" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
99 </outputs>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
100 <tests>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
101 <test>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
102 <param name="read_group_0|segments|type" value="interleaved" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
103 <param name="read_group_0|segments|placement" value="fb" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
104 <param name="read_group_0|segments|dist_mode" value="ss" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
105 <param name="read_group_0|segments|min_size" value="1" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
106 <param name="read_group_0|segments|max_size" value="1000" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
107 <param name="read_group_0|segments|dist_mode" value="ss" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
108 <param name="read_group_0|segments|filename" value="SRR639755_mito_pairs.fastq.gz" ftype="fastqsanger" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
109 <param name="min_contig_len" value="200" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
110 <output name="out_fasta" file="SRR639755_mito_pairs.clc4_de_novo.fasta" ftype="fasta" />
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
111 </test>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
112 </tests>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
113 <help>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
114
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
115 **What it does**
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
116
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
117 Runs the ``clc_assembler`` tool giving a FASTA output file. You would then
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
118 typically map the same set of reads onto this assembly using ``cls_mapper``
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
119 to any perform downstream analysis using the mapped reads.
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
120
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
121
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
122 **Citation**
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
123
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
124 If you use this Galaxy tool in work leading to a scientific publication please
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
125 cite this wrapper as:
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
126
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
127 Peter J.A. Cock (2013), Galaxy wrapper for the CLC Assembly Cell suite from CLCbio
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
128 http://toolshed.g2.bx.psu.edu/view/peterjc/clc_assembly_cell
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
129
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
130 This wrapper is available to install into other Galaxy Instances via the Galaxy
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
131 Tool Shed at http://toolshed.g2.bx.psu.edu/view/peterjc/clc_assembly_cell
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
132 </help>
0996169ac2e8 Uploaded v0.0.2, previously only on the TestToolShed
peterjc
parents:
diff changeset
133 </tool>