annotate splitbysample.xml @ 82:348ad93dab47 draft default tip

Uploaded
author cropgeeks
date Wed, 07 Mar 2018 08:04:25 -0500
parents 3f84a298c6ca
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
69
805b78c41bac Uploaded
cropgeeks
parents: 68
diff changeset
1 <tool id="flapjack_split_by_sample" name="Flapjack Split By Sample" version="0.0.1">
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
2 <description>create a Flapjack project file from Flapjack formatted input files.</description>
72
841e6bf59d7e Uploaded
cropgeeks
parents: 70
diff changeset
3 <requirements>
74
4525e8876e8e Uploaded
cropgeeks
parents: 73
diff changeset
4 <requirement type="package" version="0.14.1">pandas</requirement>
72
841e6bf59d7e Uploaded
cropgeeks
parents: 70
diff changeset
5 </requirements>
69
805b78c41bac Uploaded
cropgeeks
parents: 68
diff changeset
6 <command>
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
7 python $__tool_directory__/FlapjackProject.py
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
8 -j $__tool_directory__/lib/flapjack.jar
75
2547ac473687 Uploaded
cropgeeks
parents: 74
diff changeset
9 -J $__tool_directory__/lib/pedigreeheader.jar
69
805b78c41bac Uploaded
cropgeeks
parents: 68
diff changeset
10 -g '$genotypes'
805b78c41bac Uploaded
cropgeeks
parents: 68
diff changeset
11 -s '$traits'
76
84ce7c332dc4 Uploaded
cropgeeks
parents: 75
diff changeset
12 -p '$output'
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
13 #if $map
69
805b78c41bac Uploaded
cropgeeks
parents: 68
diff changeset
14 -m '$map'
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
15 #end if
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
16 #if $qtls
69
805b78c41bac Uploaded
cropgeeks
parents: 68
diff changeset
17 -q '$qtls'
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
18 #end if
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
19 #if $adv_opts.show_advanced
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
20 -M "$adv_opts.missingData"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
21 -S "$adv_opts.hetSep"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
22 #end if
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
23 </command>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
24 <inputs>
78
3f84a298c6ca Uploaded
cropgeeks
parents: 76
diff changeset
25 <param format="fjgenotype, tabular, text" name="genotypes" type="data" label="Flapjack genotype file"
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
26 help="Flapjack-formatted (tab-delimited text) input file of genotype data"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
27
78
3f84a298c6ca Uploaded
cropgeeks
parents: 76
diff changeset
28 <param format="tabular, text" name="traits" type="data" label="Flapjack phenotype file"
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
29 help="Flapjack-formatted (tab-delimited text) input file of phenotype data"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
30
78
3f84a298c6ca Uploaded
cropgeeks
parents: 76
diff changeset
31 <param format="fjmap, tabular, text" name="map" type="data" label="Flapjack map file"
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
32 help="Flapjack-formatted (tab-delimited text) input file of map data"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
33 optional="true"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
34
78
3f84a298c6ca Uploaded
cropgeeks
parents: 76
diff changeset
35 <param format="fjqtl, tabular, text" name="qtls" type="data" label="Flapjack QTL file"
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
36 help="Flapjack-formatted (tab-delimited text) input file of QTL data"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
37 optional="true"/>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
38
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
39 <!-- 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
40 <conditional name="adv_opts">
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
41 <param name="show_advanced" type="boolean"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
42 label="Enable advanced options"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
43 truevalue="show" falsevalue="">
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
44 </param>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
45 <when value="show">
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
46 <param name="missingData" type="text" value="-"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
47 label="Missing data string"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
48 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
49
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
50 <param name="hetSep" type="text" value="/"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
51 label="Heterozygous allele separator string"
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
52 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
53 </when>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
54 </conditional>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
55 <!-- 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
56 </inputs>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
57
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
58 <outputs>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
59 <data name="output" format="flapjack" />
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
60 </outputs>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
61
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
62 <stdio>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
63 <exit_code range="1:" />
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
64 </stdio>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
65
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
66 <help><![CDATA[
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
67 .. class:: infomark
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
68
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
69 **What it does**
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
70
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
71 Flapjack is a multi-platform application providing interactive visualizations of high-throughput genotype data,
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
72 allowing for rapid navigation and comparisons between lines, markers and chromosomes.
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
73
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
74 This tool creates a Flapjack project file from the supplied tab-delimitted flapjack input files.
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
75 See Flapjack's documentation_ for more details on the various Flapjack data formats.
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
76 More information on the CreateProject tool can be found here_
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
77
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
78 .. _documentation: http://flapjack.hutton.ac.uk/en/latest/projects_&_data_formats.html
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
79 .. _here: http://flapjack.hutton.ac.uk/en/latest/command_line_support.html#createproject-exe-jhi-flapjack-io-createproject
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
80 ]]></help>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
81
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
82 <citations>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
83 <citation type="doi">10.1093/bioinformatics/btq580</citation>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
84 </citations>
dc02f001fd09 Uploaded
cropgeeks
parents:
diff changeset
85 </tool>