annotate PedToFasta/pedToFasta.xml @ 5:ec22fcacb66c draft

planemo upload
author gandres
date Mon, 15 Feb 2016 10:26:18 -0500
parents 10627af23f10
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
1 <tool id="sniplay_pedToFasta" name="Ped2Fasta" version="1.0.0">
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
2
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
3 <!-- [REQUIRED] Tool description displayed after the tool name -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
4 <description> Convert PED file to Fasta File </description>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
5
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
6 <!-- [OPTIONAL] 3rd party tools, binaries, modules... required for the tool to work -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
7 <requirements>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
8 <requirement type="binary">perl</requirement>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
9 </requirements>
4
10627af23f10 planemo upload
gandres
parents: 1
diff changeset
10
10627af23f10 planemo upload
gandres
parents: 1
diff changeset
11 <!-- [STRONGLY RECOMMANDED] Exit code rules -->
10627af23f10 planemo upload
gandres
parents: 1
diff changeset
12 <stdio>
10627af23f10 planemo upload
gandres
parents: 1
diff changeset
13 <!-- [HELP] If no exit code rule is defined, the tool will stop if anything is written to STDERR -->
10627af23f10 planemo upload
gandres
parents: 1
diff changeset
14 <exit_code range="1:" level="fatal" />
10627af23f10 planemo upload
gandres
parents: 1
diff changeset
15 </stdio>
1
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
16
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
17 <!-- [OPTIONAL] Command to be executed to get the tool's version string -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
18 <version_command>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
19 <!--
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
20 tool_binary -v
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
21 -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
22 </version_command>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
23
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
24 <!-- [REQUIRED] The command to execute -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
25 <command interpreter="perl">
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
26 Ped2Fasta.pl --in $filein --out $fileout
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
27 </command>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
28
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
29 <!-- [REQUIRED] Input files and tool parameters -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
30 <inputs>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
31 <param name="filein" type="data" format="txt" optional="false" label="PED input" />
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
32 <param name="fileout_label" type="text" value="filtered" optional="false" label="Output file name"/>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
33 </inputs>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
34
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
35 <!-- [REQUIRED] Output files -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
36 <outputs>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
37 <data name="fileout" type="data" format="fasta" label="${fileout_label}.fa" />
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
38 </outputs>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
39
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
40 <!-- [OPTIONAL] Tests to be run manually by the Galaxy admin -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
41 <tests>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
42 <!-- [HELP] Test files have to be in the ~/test-data directory -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
43 <test>
4
10627af23f10 planemo upload
gandres
parents: 1
diff changeset
44 <param name="filein" value="ped2fasta-sample.ped" />
10627af23f10 planemo upload
gandres
parents: 1
diff changeset
45 <output name="fileout" file="ped2fasta-result.fa" />
1
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
46 </test>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
47 </tests>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
48
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
49 <!-- [OPTIONAL] Help displayed in Galaxy -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
50 <help>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
51
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
52 .. class:: infomark
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
53
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
54 **Authors** Dereeper Alexis (alexis.dereeper@ird.fr), IRD, South Green platform
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
55
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
56 | **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).
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
57
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
58 .. class:: infomark
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
59
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
60 **Galaxy integration** Andres Gwendoline, Institut Français de Bioinformatique.
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
61
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
62 .. class:: infomark
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
63
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
64 **Support** For any questions, please send an e-mail to support.abims@sb-roscoff.fr
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
65
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
66 ---------------------------------------------------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
67
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
68 =========
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
69 Ped2Fasta
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
70 =========
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
71
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
72 -----------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
73 Description
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
74 -----------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
75
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
76 Convert PED file to Fasta File
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
77
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
78 -----------------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
79 Workflow position
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
80 -----------------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
81
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
82 **Upstream tool**
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
83
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
84 =============== ========================== =======
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
85 Name output file(s) format
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
86 =============== ========================== =======
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
87 VCFtools Filter VCF file VCF
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
88 =============== ========================== =======
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
89
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
90
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
91 **Downstream tool**
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
92
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
93 =========== ========================== =======
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
94 Name input file(s) format
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
95 =========== ========================== =======
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
96 Readseq Fasta alignment fasta
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
97 =========== ========================== =======
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
98
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
99
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
100 ----------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
101 Input file
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
102 ----------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
103
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
104 PED file
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
105 PED file usually from VCF tools
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
106
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
107 ----------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
108 Parameters
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
109 ----------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
110
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
111 Output file name
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
112 Prefix for the output fasta file
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
113
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
114 ------------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
115 Output files
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
116 ------------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
117
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
118 Fasta file
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
119 PED file conversion
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
120
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
121 ---------------------------------------------------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
122
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
123 ---------------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
124 Working example
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
125 ---------------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
126
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
127 Input files
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
128 ===========
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
129
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
130 PED file
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
131 ---------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
132
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
133 ::
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
134
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
135 CATB1 CATB1 0 0 0 0 C T T A C T A T A T A G G A
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
136
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
137 Parameters
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
138 ==========
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
139
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
140 Output name -> pedFile
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
141
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
142 Output files
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
143 ============
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
144
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
145 pedFile.fa
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
146 ----------
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
147
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
148 ::
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
149
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
150 YWYWWRRSYYMKRRKMYRKSRKYRYRYKRKRSKKSYRWYSYRRYRRRWYWWYYWRRYRSRWSSRMYRRKSWMSKWRRYYWMYKYWRSYRWRYMWYYYMKYKYWRYRYRY
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
151
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
152
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
153 </help>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
154
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
155 <citations>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
156 <!-- [HELP] As DOI or BibTex entry -->
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
157 <citation type="bibtex">@article{Dereeper03062015,
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
158 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},
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
159 title = {SNiPlay3: a web-based application for exploration and large scale analyses of genomic variations},
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
160 year = {2015},
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
161 doi = {10.1093/nar/gkv351},
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
162 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.},
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
163 URL = {http://nar.oxfordjournals.org/content/early/2015/06/03/nar.gkv351.abstract},
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
164 eprint = {http://nar.oxfordjournals.org/content/early/2015/06/03/nar.gkv351.full.pdf+html},
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
165 journal = {Nucleic Acids Research}
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
166 }
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
167
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
168 </citation>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
169
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
170 </citations>
420b57c3c185 Uploaded
dereeper
parents:
diff changeset
171 </tool>