annotate cloudmap.xml @ 0:17ea8fd2ca18 draft

Imported from capsule None
author wolma
date Sat, 13 Dec 2014 17:20:01 -0500
parents
children e81a2448d1fb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
1 <tool id="cloudmap_prepare" name="Prepare variant data for mapping">
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
2 <description>with the CloudMap series of tools.</description>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
3 <requirements>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
4 <requirement type="package" version="0.1.5">mimodd</requirement>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
5 </requirements>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
6 <version_command>mimodd version -q</version_command>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
7 <command>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
8 mimodd cloudmap "$ifile" ${run.mode}
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
9
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
10 #if $str($run.mode) != "EMS":
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
11 "${run.refsample}"
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
12 #end if
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
13
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
14 "$sample" -o $ofile
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
15
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
16 #if $seqdict:
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
17 -s $dictfile
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
18 #end if
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
19 </command>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
20
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
21 <inputs>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
22 <param name="ifile" type="data" format="vcf" label="vcf input file" />
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
23 <conditional name="run">
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
24 <param name="mode" type="select" label="CloudMap analysis to prepare data for">
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
25 <option value="EMS">EMS Variant Density Mapping</option>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
26 <option value="VARIANT">Variant Discovery Mapping</option>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
27 <option value="HAWAIIAN">Hawaiian Variant Mapping</option>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
28 </param>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
29 <when value="EMS">
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
30 <param name="refsample" type="hidden" value="None" />
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
31 </when>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
32 <when value="VARIANT">
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
33 <param name="refsample" type="text" label="name of the reference sample" help="the sample that provides crossing strain variants to be EXCLUDED from the analysis" />
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
34 </when>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
35 <when value="HAWAIIAN">
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
36 <param name="refsample" type="text" label="name of the reference sample" help="the sample that provides crossing strain variants to be INCLUDED in the analysis" />
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
37 </when>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
38 </conditional>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
39 <param name="sample" type="text" label="subject sample name" help="the sample to perform CloudMap mapping for" />
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
40 <param name="seqdict" type="boolean" checked="true" label="Generate species configuration file for CloudMap" />
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
41
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
42 </inputs>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
43
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
44 <outputs>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
45 <data name="ofile" format="vcf" label="CloudMap ${run.mode} Mapping-ready VCF File from ${on_string}" />
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
46 <data name="dictfile" format="tabular" label="Species Configuration File for CloudMap from ${on_string}">
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
47 <filter>seqdict</filter>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
48 </data>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
49 </outputs>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
50
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
51 <help>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
52 .. class:: infomark
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
53
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
54 **What it does**
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
55
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
56 The purpose of this tool is to provide compatibility of the MiModD analysis workflow with the external `CloudMap`_ *EMS Variant Density Mapping*, *Variant Discovery Mapping* and *Hawaiian Variant Mapping* tools.
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
57
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
58 These tools complement MiModD by providing easily interpreted visualizations of mapping-by-sequencing analysis workflows.
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
59
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
60 The tool converts a VCF file as generated by the *Extract Variant Sites* or *VCF Filter* tools to the format expected by the *CloudMap* series of tools.
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
61
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
62 Optionally, it also extracts the chromosome names and sizes and reports them in the *CloudMap* *species configuration file* format.
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
63 Such a file is required as input to the current versions of the *CloudMap* *Hawaiian* and *Variant Density* mapping tools, if you are working with a species other than the natively supported ones (i.e., other than *C. elegans* or *A. thaliana*).
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
64
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
65 To use the output datasets of the tool with *CloudMap*, you only have to upload them to any public Galaxy server that hosts *CloudMap* like, e.g., the main Galaxy server at https://usegalaxy.org .
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
66
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
67 .. class:: warningmark
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
68
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
69 EMS Variant Density Mapping is currently limited to *C. elegans* and other species with six chromosomes on the *CloudMap* side.
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
70
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
71 .. _CloudMap: https://usegalaxy.org/u/gm2123/p/cloudmap
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
72
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
73 </help>
17ea8fd2ca18 Imported from capsule None
wolma
parents:
diff changeset
74 </tool>