annotate splitbysample.xml @ 68:dc02f001fd09 draft

Uploaded
author cropgeeks
date Wed, 21 Feb 2018 12:03:38 -0500
parents
children 805b78c41bac
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
1 <tool id="flapjack_createproject" name="Flapjack CreateProject" version="0.0.1">
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
2 <description>create a Flapjack project file from Flapjack formatted input files.</description>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
3 <command><![CDATA[
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
4 python $__tool_directory__/FlapjackProject.py
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
5 -j $__tool_directory__/lib/flapjack.jar
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
6 -g $genotypes
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
7 -s $traits
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
8 #if $map
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
9 -m $map
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
10 #end if
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
11 #if $name
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
12 -n $name
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
13 #end if
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
14 #if $qtls
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
15 -q $qtls
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
16 #end if
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
17 #if $adv_opts.show_advanced
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
18 -M "$adv_opts.missingData"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
19 -S "$adv_opts.hetSep"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
20 #end if
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
21 ]]>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
22 </command>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
23 <inputs>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
24 <param format="fjgenotype" name="genotypes" type="data" label="Flapjack genotype file"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
25 help="Flapjack-formatted (tab-delimited text) input file of genotype data"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
26
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
27 <param format="fjphenotype" name="traits" type="data" label="Flapjack phenotype file"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
28 help="Flapjack-formatted (tab-delimited text) input file of phenotype data"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
29
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
30 <param format="fjmap" name="map" type="data" label="Flapjack map file"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
31 help="Flapjack-formatted (tab-delimited text) input file of map data"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
32 optional="true"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
33
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
34 <param format="fjqtl" name="qtls" type="data" label="Flapjack QTL file"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
35 help="Flapjack-formatted (tab-delimited text) input file of QTL data"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
36 optional="true"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
37
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
38 <!-- WARNING: Below is the advanced options section shared by all of our tools. If you alter it here you must update the other tools as well.-->
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
39 <conditional name="adv_opts">
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
40 <param name="show_advanced" type="boolean"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
41 label="Enable advanced options"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
42 truevalue="show" falsevalue="">
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
43 </param>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
44 <when value="show">
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
45 <param name="missingData" type="text" value="-"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
46 label="Missing data string"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
47 help="Alleles with missing data are encoded using this string. Clear the box to use an empty string for missing data instead."/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
48
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
49 <param name="hetSep" type="text" value="/"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
50 label="Heterozygous allele separator string"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
51 help="Specifies the string used to separator heterozygous alleles (eg 'A/T'). Clear the box to specify no string is used (eg 'AT')"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
52 </when>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
53 </conditional>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
54 <!-- WARNING: Above is the advanced options section shared by all of our tools. If you alter it here you must update the other tools as well.-->
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
55 </inputs>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
56
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
57 <outputs>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
58 <data name="output" format="flapjack" />
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
59 </outputs>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
60
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
61 <stdio>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
62 <exit_code range="1:" />
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
63 </stdio>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
64
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
65 <help><![CDATA[
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
66 .. class:: infomark
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
67
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
68 **What it does**
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
69
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
70 Flapjack is a multi-platform application providing interactive visualizations of high-throughput genotype data,
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
71 allowing for rapid navigation and comparisons between lines, markers and chromosomes.
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
72
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
73 This tool creates a Flapjack project file from the supplied tab-delimitted flapjack input files.
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
74 See Flapjack's documentation_ for more details on the various Flapjack data formats.
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
75 More information on the CreateProject tool can be found here_
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
76
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
77 .. _documentation: http://flapjack.hutton.ac.uk/en/latest/projects_&_data_formats.html
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
78 .. _here: http://flapjack.hutton.ac.uk/en/latest/command_line_support.html#createproject-exe-jhi-flapjack-io-createproject
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
79 ]]></help>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
80
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
81 <citations>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
82 <citation type="doi">10.1093/bioinformatics/btq580</citation>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
83 </citations>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
84 </tool>