annotate createproject.xml @ 6:e8083821455b draft

Uploaded
author cropgeeks
date Tue, 21 Feb 2017 08:34:36 -0500
parents 735f690bdb76
children 8855844f40a8
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">
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
2
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
3 <!--System.out.println("Usage: createproject <options>\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
4 + " where valid options are:\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
5 + " -map=<map_file> (optional input file)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
6 + " -genotypes=<genotypes_file> (required input file)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
7 + " -traits=<traits_file> (optional input file)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
8 + " -qtls=<qtl_file> (optional input file)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
9 + " -decimalEnglish (optional input parameter)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
10 + " -project=<project_file> (required output file)\n");-->
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
11
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
12 <description>Run pedigree verification of F1s (known parents) analysis</description>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
13 <command><![CDATA[
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
14 java -Xmx$memory -cp $__tool_directory__/lib/flapjack.jar jhi.flapjack.io.cmd.CreateProject
6
e8083821455b Uploaded
cropgeeks
parents: 5
diff changeset
15 -map=$map -genotypes=$genotypes
e8083821455b Uploaded
cropgeeks
parents: 5
diff changeset
16 ## -galaxyHTML=$html
e8083821455b Uploaded
cropgeeks
parents: 5
diff changeset
17 -project=$output
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
18 ]]>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
19 </command>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
20 <inputs>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
21 <param format="fjmap" name="map" type="data" label="Flapjack map file"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
22 help="Flapjack-formatted (tab-delimited text) input file of map data"/>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
23 <param format="fjgenotype" name="genotypes" type="data" label="Flapjack genotype file"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
24 help="Flapjack-formatted (tab-delimited text) input file of genotype data"/>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
25
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
26 <param argument="decimalEnglish" type="boolean" truevalue="-decimalEnglish" falsevalue="" checked="True"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
27 label="Read input data using decimal English"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
28 help="Build the index using a perfect hash rather than a dense hash. This will require less memory
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
29 (especially during quantification), but will take longer to construct "/>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
30 <param name="memory" type="select" label="Memory"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
31 help="How much memory to use; larger files may require more memory">
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
32 <option selected="true" value="64m">64MB</option>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
33 <option value="128m">128MB</option>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
34 <option value="256m">256MB</option>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
35 </param>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
36 </inputs>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
37 <outputs>
5
735f690bdb76 Uploaded
cropgeeks
parents: 4
diff changeset
38 <!-- label="${tool.name} on ${on_string}: project.flapjack" -->
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
39 <data name="output" format="flapjack" />
6
e8083821455b Uploaded
cropgeeks
parents: 5
diff changeset
40 <!--<data name="html" format="html" />-->
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
41 </outputs>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
42
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
43 <stdio>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
44 <exit_code range="1:" />
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
45 </stdio>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
46
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
47 <help><![CDATA[
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
48 .. class:: infomark
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
49
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
50 **What it does**
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
51
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
52 Flapjack is a multi-platform application providing interactive visualizations of high-throughput genotype data,
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
53 allowing for rapid navigation and comparisons between lines, markers and chromosomes.
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
54
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
55 This tool creates a Flapjack project file from the supplied tab-delimitted flapjack input files.
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
56 See Flapjack's documentation_ for more details on the various Flapjack data formats.
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
57
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
58 .. _documentation: https://ics.hutton.ac.uk/wiki/index.php/Flapjack_Help_%2D_Projects_and_Data_Formats
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
59
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
60
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
61
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
62 ]]></help>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
63 <citations>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
64 <citation type="doi">10.1093/bioinformatics/btq580</citation>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
65 </citations>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
66 </tool>