annotate pedverf1stats.xml @ 51:4ba88eb0e03b draft

Uploaded
author cropgeeks
date Mon, 01 May 2017 08:30:44 -0400
parents 8c12e46f652d
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_pedverstats" name="Flapjack PedVerStats" version="0.0.1">
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
2
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
3 <!--System.out.println("Usage: pedverf1sstats <options>\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
4 + " where valid options are:\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
5 + " -map=<map_file> (required input file)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
6 + " -genotypes=<genotypes_file> (required input file)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
7 + " -parent1=<index_of_line> (required parameter, first line is index 1)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
8 + " -parent2=<index_of_line> (required parameter, first line is index 1)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
9 + " -expectedf1=<index_of_line> (optional parameter, first line is index 1)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
10 + " -decimalEnglish (optional parameter)\n"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
11 + " -output=<output_file> (required output file)\n");-->
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
12
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
13 <description>Run pedigree verification of F1s (known parents) analysis</description>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
14 <command><![CDATA[
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
15 java -Xmx$memory -cp $__tool_directory__/lib/flapjack.jar jhi.flapjack.io.cmd.GeneratePedVerF1sStats
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
16 -map=$map -genotypes=$genotypes -parent1=$parent1 -parent2=$parent2
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
17 #if $simulate_f1.simulate_f1_selector == "file":
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
18 -expectedf1=$simulate_f1.expectedF1
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
19 #end if
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
20 $decimalEnglish -output=$output
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
21 ]]>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
22 </command>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
23 <inputs>
41
8c12e46f652d Uploaded
cropgeeks
parents: 4
diff changeset
24 <param format="fjmap" name="map" type="data" label="Flapjack map file"
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
25 help="Flapjack-formatted (tab-delimited text) input file of map data"/>
41
8c12e46f652d Uploaded
cropgeeks
parents: 4
diff changeset
26 <param format="fjgenotype" name="genotypes" type="data" label="Flapjack genotype file"
4
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
27 help="Flapjack-formatted (tab-delimited text) input file of genotype data"/>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
28 <param name="parent1" type="integer" value="1" label="Index of parent 1"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
29 help="The index of the first parent in the genotype file"/>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
30 <param name="parent2" type="integer" value="2" label="Index of parent 2"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
31 help="The index of the second parent in the genotype file"/>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
32
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
33 <conditional name="simulate_f1">
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
34 <param name="simulate_f1_selector" type="select" label="Simulate expected F1 (or use F1 from file)">
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
35 <option value="simulate" selected="True">Simulate</option>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
36 <option value="file">Select from file</option>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
37 </param>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
38 <when value="file">
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
39 <param argument="-expectedF1" type="integer" value="3" label="Index of expected F1"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
40 help="The index of the donor parent in the genotype file"/>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
41 </when>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
42 </conditional>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
43
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
44 <param argument="decimalEnglish" type="boolean" truevalue="-decimalEnglish" falsevalue="" checked="True"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
45 label="Read input data using decimal English"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
46 help="Build the index using a perfect hash rather than a dense hash. This will require less memory
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
47 (especially during quantification), but will take longer to construct "/>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
48 <param name="memory" type="select" label="Memory"
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
49 help="How much memory to use; larger files may require more memory">
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
50 <option selected="true" value="64m">64MB</option>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
51 <option value="128m">128MB</option>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
52 <option value="256m">256MB</option>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
53 </param>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
54 </inputs>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
55 <outputs>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
56 <data format="tabular" name="output" />
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
57 </outputs>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
58
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
59 <stdio>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
60 <exit_code range="1:" />
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
61 </stdio>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
62
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
63 <help><![CDATA[
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
64 .. class:: infomark
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
65
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
66 **What it does**
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
67
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
68 Flapjack is a multi-platform application providing interactive visualizations of high-throughput genotype data,
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
69 allowing for rapid navigation and comparisons between lines, markers and chromosomes.
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
70
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
71 This tool converts a Flapjack-formatted file of genotype data into a corresponding HDF5 file.
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
72 See Flapjack's documentation_ for more details on the various Flapjack data formats.
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
73
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
74 .. _documentation: https://ics.hutton.ac.uk/wiki/index.php/Flapjack_Help_%2D_Projects_and_Data_Formats
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
75
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
76
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
77
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
78 ]]></help>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
79 <citations>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
80 <citation type="doi">10.1093/bioinformatics/btq580</citation>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
81 </citations>
8970bd921458 Uploaded
cropgeeks
parents:
diff changeset
82 </tool>