annotate rave.xml @ 1:e49dcf006e1b draft

Uploaded
author gdroc
date Mon, 05 Sep 2016 04:55:34 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
1 <tool id="rave" name="RAVE" version="1.0">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
2 <description>- Rapid Allelic Variant Extractor</description>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
3 <!-- Required for the tool to work -->
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
4 <!-- Wrapper compatible with Plink v1.90b3k -->
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
5 <requirements>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
6 <requirement type="binary">perl</requirement>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
7 <requirement type="package" version="1.90">plink</requirement>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
8 </requirements>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
9 <stdio>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
10 <!-- [HELP] If no exit code rule is defined, the tool will stop if anything is written to STDERR -->
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
11 <exit_code range="1:" level="fatal" />
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
12 </stdio>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
13 <command interpreter="perl">./rave.pl
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
14 --tool_directory $__tool_directory__
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
15 --bfile ${snpdb.fields.path}
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
16 #if $filter_var.subpopulation == 'yes':
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
17 --keep ${filter_var.population_select.fields.path}
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
18 #end if
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
19 #if $filter_individuals.individual == 'file':
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
20 --keep ${filter_individuals.variety_file}
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
21 #else if $filter_individuals.individual == 'list':
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
22 --variety_list "${filter_individuals.variety_list}"
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
23 #end if
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
24 #if $filter_loc.location == 'file':
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
25 --extract range ${filter_loc.location_file}
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
26 #else if $filter_loc.location == 'list':
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
27 --location_list "${filter_loc.location_list}"
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
28 #end if
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
29 #if $filter_locus.locus == 'file':
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
30 --extract range ${filter_locus.locus_file}
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
31 #else if $filter_locus.locus == 'list':
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
32 --locus_list "${filter_locus.locus_list}"
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
33 #end if
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
34 --maf $maf
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
35 --output_format $output_format
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
36 --out $plink_output
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
37 </command>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
38 <inputs>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
39 <param name="snpdb" type="select" label="Select SNP DB" help="If your genome of interest is not listed, contact us">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
40 <options from_data_table="plink">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
41 <filter type="sort_by" column="1"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
42 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
43 </options>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
44 </param>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
45 <param name="maf" type="float" value="0.01" label="Minor allele frequencies" help="--maf filters out all variants with minor allele frequency below the provided threshold (default 0.01)" />
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
46 <conditional name="filter_var">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
47 <param name="subpopulation" type="select" label="Filter SNP based on subpopulation">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
48 <option value="no">No</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
49 <option value="yes">Yes</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
50 </param>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
51 <when value="no"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
52 <when value="yes">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
53 <param name="population_select" type="select" display="radio" label="Subpopulation">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
54 <options from_data_table="subpopulation">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
55 <filter type="sort_by" column="1"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
56 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
57 </options>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
58 </param>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
59 </when>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
60 </conditional>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
61 <conditional name="filter_individuals">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
62 <param name="individual" type="select" label="Filter SNP based on individual (This parameter can be empty)">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
63 <option value="file">Upload a file from your history</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
64 <option value="list">Cut &amp; Paste your list</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
65 </param>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
66 <when value="file">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
67 <param name="variety_file" format="txt" type="data" optional="true" label="Variety list from file" help="One range per line, whitespace-separated (i.e : B001 B001)"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
68 </when>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
69 <when value="list">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
70 <param name="variety_list" type="text" area="True" size="5x15" label="Variety list from area" help="One range per line, whitespace-separated (i.e : B001 B001)"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
71 </when>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
72 </conditional>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
73
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
74 <conditional name="filter_loc">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
75 <param name="location" type="select" label="Filter SNP based on genomic location (This parameter can be empty)">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
76 <option value="file">Upload a file from your history</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
77 <option value="list">Cut &amp; Paste your list</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
78 </param>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
79 <when value="file">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
80 <param name="location_file" format="txt" type="data" optional="true" label="Range list from file" help="One range per line, whitespace-separated (i.e : 1 100000 120000 chr1)"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
81 </when>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
82 <when value="list">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
83 <param name="location_list" type="text" area="True" size="5x15" label="Range list from area" help="One range per line, whitespace-separated (i.e : 1 100000 120000 chr1)"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
84 </when>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
85 </conditional>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
86 <conditional name="filter_locus">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
87 <param name="locus" type="select" label="Filter SNP based on specific locus (This parameter can be empty)">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
88 <option value="file">Upload a file from your history</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
89 <option value="list">Cut &amp; Paste your list</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
90 </param>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
91 <when value="file">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
92 <param name="locus_file" format="txt" type="data" optional="true" label="Locus file (MSU locus name)" help="One locus per line (i.e : LOC_Os01g13620)"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
93 </when>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
94 <when value="list">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
95 <param name="locus_list" type="text" area="True" size="5x15" label="Locus list from area (MSU locus name)" help="One range per line (i.e : LOC_Os01g13620)"/>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
96 </when>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
97 </conditional>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
98 <param name="output_format" type="select" label="Select output format" help="--recode creates a new text fileset, after applying sample/variant filters and other operations.">
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
99 <option value="vcf">VCF</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
100 <option value="bgz">VCF bgzip</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
101 <option value="structure">Structure</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
102 <option value="beagle">Beagle</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
103 <option value="fastphase">fastPHASE</option>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
104 </param>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
105 </inputs>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
106 <outputs>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
107 <data format="vcf" name="plink_output" label="${output_format} output" />
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
108 <change_format>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
109 <when input="output_format" value="structure" format="txt" />
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
110 <when input="output_format" value="beagle" format="bgzip" />
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
111 <when input="output_format" value="fastphase" format="bgzip" />
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
112 <when input="output_format" value="bgz" format="bgzip" />
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
113 </change_format>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
114 <!--output.recode.strct_in-->
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
115 </outputs>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
116 <help>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
117
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
118 .. class:: infomark
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
119
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
120 **Program encapsulated in Galaxy by South Green**
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
121
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
122 .. class:: infomark
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
123
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
124 -----
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
125
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
126 ==========
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
127 Overview
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
128 ==========
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
129
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
130 **PLINK Overview**
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
131
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
132 PLINK2
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
133 Majority of information in this page is derived from an excellent PLINK_ manual written by Shaun Purcell, Christopher Chang.
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
134
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
135 .. _PLINK: https://www.cog-genomics.org/plink2
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
136
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
137 .. class:: infomark
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
138
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
139 **Galaxy integration** Droc Gaetan (CIRAD), Ruiz Manuel (CIRAD).
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
140
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
141 .. class:: infomark
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
142
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
143 **Support** For any questions about Galaxy integration, please send an e-mail to southgreen@cirad.fr
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
144
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
145
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
146 -------
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
147
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
148 </help>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
149 <citations>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
150 <citation type="doi">10.1186/s13742-015-0047-8</citation>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
151 <citation type="doi">10.1086/519795</citation>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
152 </citations>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
153 </tool>
e49dcf006e1b Uploaded
gdroc
parents:
diff changeset
154