annotate check_gwas_inputs/CheckGWASInputs.xml @ 4:10627af23f10 draft

planemo upload
author gandres
date Tue, 15 Dec 2015 05:18:02 -0500
parents 345f88a8f483
children ec22fcacb66c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
1 <tool id="check_GWAS_inputs" name="Check GWAS Inputs" version="1.0">
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
2 <description>checks concordance between input files for GWAS analysis</description>
4
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
3
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
4 <!-- [OPTIONAL] 3rd party tools, binaries, modules... required for the tool to work -->
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
5 <requirements>
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
6 <requirement type="binary">perl</requirement>
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
7 </requirements>
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
8
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
9 <!-- [STRONGLY RECOMMANDED] Exit code rules -->
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
10 <stdio>
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
11 <!-- [HELP] If no exit code rule is defined, the tool will stop if anything is written to STDERR -->
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
12 <exit_code range="1:" level="fatal" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
13 </stdio>
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
14
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
15 <command interpreter="bash">./CheckGWASInputs.sh $hapmap $trait $out_hapmap $out_trait $stats
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
16 </command>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
17 <inputs>
4
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
18 <param format="text" name="hapmap" type="data" label="Allelic file in Hapmap format" help="Allelic file in Hapmap format"/>
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
19 <param format="text" name="trait" type="data" label="Trait file" help="Phenotypic file"/>
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
20 </inputs>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
21 <outputs>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
22 <data format="txt" name="out_hapmap" label="Hapmap output"/>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
23 <data format="txt" name="out_trait" label="Trait output"/>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
24 <data format="txt" name="stats" label="Logfile and statistics"/>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
25 </outputs>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
26
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
27 <!-- [OPTIONAL] Tests to be run manually by the Galaxy admin -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
28 <tests>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
29 <!-- [HELP] Test files have to be in the ~/test-data directory -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
30 <!-- [HELP] Multiple tests can be defined with different parameters -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
31 <test>
4
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
32 <param name="hapmap" value="gwas-hapmap" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
33 <param name="trait" value="gwas-trait" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
34 <output name="out_hapmap" file="gwas-result.hapmap" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
35 <output name="out_trait" file="gwas-result.trait" />
10627af23f10 planemo upload
gandres
parents: 3
diff changeset
36 <output name="stats" file="gwas-result.stats" />
3
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
37 </test>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
38 </tests>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
39 <help>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
40
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
41 <![CDATA[
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
42
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
43
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
44 .. class:: infomark
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
45
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
46 **Authors** South Green
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
47
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
48 | **Please cite** "SNiPlay3: a web-based application for exploration and large scale analyses of genomic variations", **Dereeper A. et al.**, Nucl. Acids Res. (1 july 2015) 43 (W1).
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
49
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
50 .. class:: infomark
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
51
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
52 **Galaxy integration** South Green.
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
53
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
54 ---------------------------------------------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
55
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
56
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
57 ===============
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
58 CheckGWASInputs
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
59 ===============
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
60
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
61 -----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
62 Description
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
63 -----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
64
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
65 | CheckGWASInputs checks concordance between input files for GWAS analysis.
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
66
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
67
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
68 -----------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
69 Workflow position
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
70 -----------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
71
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
72 **Upstream tool**
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
73
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
74 =============== ====================== ===========
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
75 Name output file(s) format
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
76 =============== ====================== ===========
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
77 VCF to Hapmap Hapmap file hapmap
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
78 =============== ====================== ===========
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
79
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
80
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
81
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
82
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
83 ----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
84 Input file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
85 ----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
86
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
87 Hapmap file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
88 Allelic file in Hapmap format
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
89
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
90 Trait file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
91 Phenotypic file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
92
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
93 ------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
94 Output files
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
95 ------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
96
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
97 Hapmap output
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
98
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
99 Trait output
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
100
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
101 Logfile and statistics
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
102
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
103 ---------------------------------------------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
104
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
105 ---------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
106 Working example
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
107 ---------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
108
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
109 Input files
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
110 ===========
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
111
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
112 Hapmap file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
113 -----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
114
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
115 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
116
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
117 rs# alleles chrom pos strand assembly# center protLSID assayLSID panel QCcode Ind1 Ind2
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
118 SNP1 A/T 1 3102 + assembly NA NA NA speciesname NA AA AA AA
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
119 SNP2 A/T 1 4648 + assembly NA NA NA speciesname NA AA AA AA
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
120
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
121 Trait file
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
122 ----------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
123
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
124 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
125
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
126 <Trait> Test
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
127 Ind1 -2.9985936006411
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
128 Ind2 -2.68669426456267
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
129
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
130 Output files
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
131 ============
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
132
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
133 Hapmap output
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
134 -------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
135
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
136 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
137
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
138 rs# alleles chrom pos strand assembly# center protLSID assayLSID panel QCcode Ind1 Ind2 Ind3 Ind4
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
139 SNP1 A/T 1 3102 + assembly NA NA NA speciesname NA AA AA AA AA AA
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
140 SNP2 A/T 1 4648 + assembly NA NA NA speciesname NA AA AA AA AA TT
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
141
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
142
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
143 Trait output
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
144 ------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
145
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
146 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
147
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
148 <Trait> Test
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
149 Ind429 -26.2142525264157
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
150 Ind373 12.0306115988504
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
151 Ind81 1.98118654229534
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
152
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
153 Logfile and statistics
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
154 ----------------------
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
155
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
156 ::
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
157
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
158
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
159 ==============================================
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
160 Individuals
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
161 ==============================================
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
162 Individuals in hapmap file: 500
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
163 Individuals in trait file: 500
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
164 Individuals found in both files: 500
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
165 ==============================================
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
166 Markers
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
167 ==============================================
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
168 Discarded markers:
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
169 Monomorphic: 0
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
170 Not biallelic: 0
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
171 Modified markers:
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
172 Difference in variation: 0
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
173
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
174 ]]>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
175
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
176
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
177 </help>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
178 <citations>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
179 <!-- [HELP] As DOI or BibTex entry -->
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
180 <citation type="bibtex">@article{Dereeper03062015,
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
181 author = {Dereeper, Alexis and Homa, Felix and Andres, Gwendoline and Sempere, Guilhem and Sarah, Gautier and Hueber, Yann and Dufayard, Jean-François and Ruiz, Manuel},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
182 title = {SNiPlay3: a web-based application for exploration and large scale analyses of genomic variations},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
183 year = {2015},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
184 doi = {10.1093/nar/gkv351},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
185 abstract ={SNiPlay is a web-based tool for detection, management and analysis of genetic variants including both single nucleotide polymorphisms (SNPs) and InDels. Version 3 now extends functionalities in order to easily manage and exploit SNPs derived from next generation sequencing technologies, such as GBS (genotyping by sequencing), WGRS (whole gre-sequencing) and RNA-Seq technologies. Based on the standard VCF (variant call format) format, the application offers an intuitive interface for filtering and comparing polymorphisms using user-defined sets of individuals and then establishing a reliable genotyping data matrix for further analyses. Namely, in addition to the various scaled-up analyses allowed by the application (genomic annotation of SNP, diversity analysis, haplotype reconstruction and network, linkage disequilibrium), SNiPlay3 proposes new modules for GWAS (genome-wide association studies), population stratification, distance tree analysis and visualization of SNP density. Additionally, we developed a suite of Galaxy wrappers for each step of the SNiPlay3 process, so that the complete pipeline can also be deployed on a Galaxy instance using the Galaxy ToolShed procedure and then be computed as a Galaxy workflow. SNiPlay is accessible at http://sniplay.southgreen.fr.},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
186 URL = {http://nar.oxfordjournals.org/content/early/2015/06/03/nar.gkv351.abstract},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
187 eprint = {http://nar.oxfordjournals.org/content/early/2015/06/03/nar.gkv351.full.pdf+html},
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
188 journal = {Nucleic Acids Research}
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
189 }
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
190
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
191 </citation>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
192
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
193 </citations>
345f88a8f483 Uploaded
dereeper
parents:
diff changeset
194 </tool>