annotate cloudmap.xml @ 0:6231ae8f87b8

Uploaded
author wolma
date Wed, 11 Feb 2015 08:29:02 -0500
parents
children a548b3c6ed00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
1 <tool id="cloudmap_prepare" name="Prepare variant data for mapping">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
2 <description>with the CloudMap series of tools.</description>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
3 <version_command>mimodd version -q</version_command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
4 <command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
5 mimodd cloudmap "$ifile" ${run.mode}
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
6
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
7 #if $str($run.mode) != "SVD":
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
8 "${run.refsample}"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
9 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
10
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
11 "$sample" -o "$ofile"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
12
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
13 #if $seqdict:
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
14 -s "$dictfile"
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
15 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
16 </command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
17
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
18 <inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
19 <param name="ifile" type="data" format="vcf" label="vcf input file" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
20 <conditional name="run">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
21 <param name="mode" type="select" label="CloudMap analysis to prepare data for">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
22 <option value="SVD">EMS Variant Density Mapping</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
23 <option value="VAF">Variant Discovery / Hawaiian Variant Mapping</option>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
24 </param>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
25 <when value="SVD">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
26 <param name="refsample" type="hidden" value="None" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
27 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
28 <when value="VAF">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
29 <param name="refsample" type="text" label="name of the reference sample" help="the sample that provides mapping strain variants" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
30 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
31 </conditional>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
32 <param name="sample" type="text" label="subject sample name" help="the sample to perform CloudMap mapping for" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
33 <param name="seqdict" type="boolean" checked="true" label="Generate species configuration file for CloudMap" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
34
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
35 </inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
36
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
37 <outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
38 <data name="ofile" format="vcf" label="CloudMap-ready ${run.mode} File from ${on_string}" />
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
39 <data name="dictfile" format="tabular" label="Species Configuration File for CloudMap from ${on_string}">
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
40 <filter>seqdict</filter>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
41 </data>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
42 </outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
43
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
44 <help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
45 .. class:: infomark
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
46
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
47 **What it does**
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
48
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
49 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.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
50
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
51 These tools complement MiModD by providing easily interpreted visualizations of mapping-by-sequencing analysis workflows.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
52
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
53 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.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
54
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
55 Optionally, it also extracts the chromosome names and sizes and reports them in the *CloudMap* *species configuration file* format.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
56 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*).
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
57
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
58 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 .
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
59
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
60 .. class:: warningmark
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
61
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
62 EMS Variant Density Mapping is currently limited to *C. elegans* and other species with six chromosomes on the *CloudMap* side.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
63
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
64 More information on combining MiModD and CloudMap in mapping-by-sequencing analyses can be found in the `corresponding section of the MiModD User Guide`_.
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
65
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
66 .. _CloudMap: https://usegalaxy.org/u/gm2123/p/cloudmap
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
67 .. _corresponding section of the MiModD User Guide: http://mimodd.readthedocs.org/en/latest/cloudmap.html
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
68
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
69 </help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
70 </tool>