Mercurial > repos > cropgeeks > flapjack

annotate createproject.xml @ 55:6777844fd638 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated the descriptions of the Flapjack tools to be more consistent.
author cropgeeks
date Tue, 14 Nov 2017 11:28:35 -0500
parents 8855844f40a8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
1 <tool id="flapjack_createproject" name="Flapjack CreateProject" version="0.0.1">
55
6777844fd638 Updated the descriptions of the Flapjack tools to be more consistent.
cropgeeks
parents: 54
diff changeset
2 <description>create a Flapjack project file from Flapjack formatted input files.</description>
54
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
3 <command><![CDATA[
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
4 java
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
5 #if $adv_opts.show_advanced
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
6 -Xmx$adv_opts.memory
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
7 #end if
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
8 -cp $__tool_directory__/lib/flapjack.jar jhi.flapjack.io.cmd.CreateProject
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
9 -g $genotypes
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
10 -p $output
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
11 #if $map
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
12 -m $map
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
13 #end if
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
14 #if $name
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
15 -n $name
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
16 #end if
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
17 #if $qtls
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
18 -q $qtls
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
19 #end if
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
20 #if $traits
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
21 -t $traits
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
22 #end if
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
23 #if $adv_opts.show_advanced
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
24 $adv_opts.allChromosomes
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
25 $adv_opts.collapseHets
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
26 -M "$adv_opts.missingData"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
27 -S "$adv_opts.hetSep"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
28 $adv_opts.transposed
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
29 $adv_opts.decimalEnglish
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
30 #end if
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
31 ]]>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
32 </command>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
33 <inputs>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
34 <param format="fjgenotype" name="genotypes" type="data" label="Flapjack genotype file"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
35 help="Flapjack-formatted (tab-delimited text) input file of genotype data"/>
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
36
54
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
37 <param format="fjmap" name="map" type="data" label="Flapjack map file"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
38 help="Flapjack-formatted (tab-delimited text) input file of map data"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
39 optional="true"/>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
40
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
41 <param format="fjphenotype" name="traits" type="data" label="Flapjack phenotype file"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
42 help="Flapjack-formatted (tab-delimited text) input file of phenotype data"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
43 optional="true"/>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
44
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
45 <param format="fjqtl" name="qtls" type="data" label="Flapjack QTL file"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
46 help="Flapjack-formatted (tab-delimited text) input file of QTL data"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
47 optional="true"/>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
48
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
49 <param format="text" name="name" type="text" label="Optional dataset name"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
50 help="The name for the dataset within Flapjack"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
51 optional="true"/>
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
52
54
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
53 <!-- 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.-->
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
54 <conditional name="adv_opts">
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
55 <param name="show_advanced" type="boolean"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
56 label="Enable advanced options"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
57 truevalue="show" falsevalue="">
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
58 </param>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
59 <when value="show">
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
60 <param name="allChromosomes" type="boolean" truevalue="-A" falsevalue="" checked="False"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
61 label="Duplicate all markers onto a single 'All Chromosomes' chromosome"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
62 help="Imports the data so that an additional 'All Chromosomes' chromosome is created, containing every marker in the dataset held together."/>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
63
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
64 <param name="collapseHets" type="boolean" truevalue="-C" falsevalue="" checked="True"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
65 label="Don't distinguish between heterozygous alleles"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
66 help="Ignores phase between heterozygous alleles, treating, for example, A/T the same as T/A."/>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
67
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
68 <param name="missingData" type="text" value="-"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
69 label="Missing data string"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
70 help="Alleles with missing data are encoded using this string. Clear the box to use an empty string for missing data instead."/>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
71
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
72 <param name="hetSep" type="text" value="/"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
73 label="Heterozygous allele separator string"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
74 help="Specifies the string used to separator heterozygous alleles (eg 'A/T'). Clear the box to specify no string is used (eg 'AT')"/>
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
75
54
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
76 <param name="transposed" type="boolean" truevalue="-T" falsevalue="" checked="False"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
77 label="Genotype data has been transposed"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
78 help="Flapjack's default format has markers as columns. Select this to specify markers as rows instead."/>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
79
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
80 <param name="decimalEnglish" type="boolean" truevalue="-D" falsevalue="" checked="False"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
81 label="Force English-style decimal marks"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
82 help="Always process input data using '.' as the decimal separator, irrespective of this Galaxy server's locale settings."/>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
83
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
84 <param name="memory" type="select"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
85 label="Memory"
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
86 help="How much memory to use (larger files may require more memory).">
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
87 <option selected="true" value="64m">64MB</option>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
88 <option value="128m">128MB</option>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
89 <option value="256m">256MB</option>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
90 </param>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
91 </when>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
92 </conditional>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
93 <!-- 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.-->
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
94 </inputs>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
95
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
96 <outputs>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
97 <data name="output" format="flapjack" />
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
98 </outputs>
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
99
54
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
100 <stdio>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
101 <exit_code range="1:" />
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
102 </stdio>
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
103
54
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
104 <help><![CDATA[
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
105 .. class:: infomark
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
106
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
107 **What it does**
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
108
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
109 Flapjack is a multi-platform application providing interactive visualizations of high-throughput genotype data,
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
110 allowing for rapid navigation and comparisons between lines, markers and chromosomes.
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
111
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
112 This tool creates a Flapjack project file from the supplied tab-delimitted flapjack input files.
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
113 See Flapjack's documentation_ for more details on the various Flapjack data formats.
54
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
114 More information on the CreateProject tool can be found here_
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
115
54
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
116 .. _documentation: http://flapjack.hutton.ac.uk/en/latest/projects_&_data_formats.html
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
117 .. _here: http://flapjack.hutton.ac.uk/en/latest/command_line_support.html#createproject-exe-jhi-flapjack-io-createproject
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
118 ]]></help>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
119
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
120 <citations>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
121 <citation type="doi">10.1093/bioinformatics/btq580</citation>
8855844f40a8 Uploaded the latest version of our Flapjack tools for Galaxy.
cropgeeks
parents: 6
diff changeset
122 </citations>
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
123 </tool>